right logo image
right logo image
Log on

v5.1.0 filtered by tag: Customer-Meeting (3 APIs)

API Host: https://api3.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions

Create Meeting (video conference/call)

Create Meeting: Initiate a video conference/call with the bank.

The Meetings resource contains meta data about video/other conference sessions

provider_id determines the provider of the meeting / video chat service. MUST be url friendly (no spaces).

purpose_id explains the purpose of the chat. onboarding | mortgage | complaint etc. MUST be url friendly (no spaces).

Login is required.

This call is experimental. Currently staff_user_id is not set. Further calls will be needed to correctly set this.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON request body fields:

contact_details:

creator:

date: 2020-01-27

email_address:

invitees:

mobile_phone:

name: ACCOUNT_MANAGEMENT_FEE

provider_id:

purpose_id:

status:

JSON response body fields:

bank_id: gh.29.uk

contact_details:

creator:

customer_token:

customer_user_id:

email_address:

invitees:

keys:

meeting_id:

mobile_phone:

name: ACCOUNT_MANAGEMENT_FEE

present:

provider_id:

purpose_id:

session_id: b4e0352a-9a0f-4bfa-b30b-9003aa467f50

staff_token:

staff_user_id:

status:

when: 2020-01-27

Typical Successful Response: 

								
									
{
  "meeting_id":"UUID-String",
  "provider_id":"Chris",
  "purpose_id":"String, eg: onboarding",
  "bank_id":"gh.29.uk",
  "present":{
    "staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "customer_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"
  },
  "keys":{
    "session_id":"String",
    "staff_token":"String",
    "customer_token":"String"
  },
  "when":"1100-01-01T00:00:00Z",
  "creator":{
    "name":"Simon ",
    "mobile_phone":"+44 07972 444 876",
    "email_address":"felixsmith@example.com"
  },
  "invitees":[{
    "contact_details":{
      "name":"Simon ",
      "mobile_phone":"+44 07972 444 876",
      "email_address":"felixsmith@example.com"
    },
    "status":"String, eg: Good"
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by createMeeting, operation_id: OBPv3.1.0-createMeeting Tags: Customer-Meeting, Customer, Experimental,

Get Meeting

Get Meeting specified by BANK_ID / MEETING_ID
Meetings contain meta data about, and are used to facilitate, video conferences / chats etc.

The actual conference/chats are handled by external services.

Login is required.

This call is experimental and will require further authorisation in the future.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

MEETING_ID:

JSON response body fields:

bank_id: gh.29.uk

contact_details:

creator:

customer_token:

customer_user_id:

email_address:

invitees:

keys:

meeting_id:

mobile_phone:

name: ACCOUNT_MANAGEMENT_FEE

present:

provider_id:

purpose_id:

session_id: b4e0352a-9a0f-4bfa-b30b-9003aa467f50

staff_token:

staff_user_id:

status:

when: 2020-01-27

Typical Successful Response: 

								
									
{
  "meeting_id":"UUID-String",
  "provider_id":"Chris",
  "purpose_id":"String, eg: onboarding",
  "bank_id":"gh.29.uk",
  "present":{
    "staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "customer_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"
  },
  "keys":{
    "session_id":"String",
    "staff_token":"String",
    "customer_token":"String"
  },
  "when":"1100-01-01T00:00:00Z",
  "creator":{
    "name":"Simon ",
    "mobile_phone":"+44 07972 444 876",
    "email_address":"felixsmith@example.com"
  },
  "invitees":[{
    "contact_details":{
      "name":"Simon ",
      "mobile_phone":"+44 07972 444 876",
      "email_address":"felixsmith@example.com"
    },
    "status":"String, eg: Good"
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30104: Meeting not found.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getMeeting, operation_id: OBPv3.1.0-getMeeting Tags: Customer-Meeting, Customer, Experimental,

Get Meetings

Meetings contain meta data about, and are used to facilitate, video conferences / chats etc.

The actual conference/chats are handled by external services.

Login is required.

This call is experimental and will require further authorisation in the future.

Authentication is Mandatory

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

bank_id: gh.29.uk

contact_details:

creator:

customer_token:

customer_user_id:

email_address:

invitees:

keys:

meeting_id:

meetings:

mobile_phone:

name: ACCOUNT_MANAGEMENT_FEE

present:

provider_id:

purpose_id:

session_id: b4e0352a-9a0f-4bfa-b30b-9003aa467f50

staff_token:

staff_user_id:

status:

when: 2020-01-27

Typical Successful Response: 

								
									
{
  "meetings":[{
    "meeting_id":"UUID-String",
    "provider_id":"Chris",
    "purpose_id":"String, eg: onboarding",
    "bank_id":"gh.29.uk",
    "present":{
      "staff_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "customer_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"
    },
    "keys":{
      "session_id":"String",
      "staff_token":"String",
      "customer_token":"String"
    },
    "when":"1100-01-01T00:00:00Z",
    "creator":{
      "name":"Simon ",
      "mobile_phone":"+44 07972 444 876",
      "email_address":"felixsmith@example.com"
    },
    "invitees":[{
      "contact_details":{
        "name":"Simon ",
        "mobile_phone":"+44 07972 444 876",
        "email_address":"felixsmith@example.com"
      },
      "status":"String, eg: Good"
    }]
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getMeetings, operation_id: OBPv3.1.0-getMeetings Tags: Customer-Meeting, Customer, Experimental,