{"resource_docs":[{"operation_id":"OBPv3.1.0-getMeetings","implemented_by":{"version":"OBPv3.1.0","function":"getMeetings"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/meetings","summary":"Get Meetings","description":"
Meetings contain meta data about, and are used to facilitate, video conferences / chats etc.
\nThe actual conference/chats are handled by external services.
\nLogin is required.
\nThis call is experimental and will require further authorisation in the future.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\n\n\n\nkeys:
\n\n\n\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\nsession_id: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
\n\n\n\nwhen: 2020-01-27
\n","description_markdown":"Meetings contain meta data about, and are used to facilitate, video conferences / chats etc.\n\nThe actual conference/chats are handled by external services.\n\nLogin is required.\n\nThis call is **experimental** and will require further authorisation in the future.\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**contact_details**](/glossary#contact_details): \n\n\n\n[**creator**](/glossary#creator): \n\n\n\n[**customer_token**](/glossary#customer_token): \n\n\n\n[**customer_user_id**](/glossary#customer_user_id): \n\n\n\n[**email_address**](/glossary#email_address): \n\n\n\n[**invitees**](/glossary#invitees): \n\n\n\n[**keys**](/glossary#keys): \n\n\n\n[**meeting_id**](/glossary#meeting_id): \n\n\n\n[**meetings**](/glossary#meetings): \n\n\n\n[**mobile_phone**](/glossary#mobile_phone): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**present**](/glossary#present): \n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**purpose_id**](/glossary#purpose_id): \n\n\n\n[**session_id**](/glossary#): b4e0352a-9a0f-4bfa-b30b-9003aa467f50\n\n\n\n[**staff_token**](/glossary#staff_token): \n\n\n\n[**staff_user_id**](/glossary#staff_user_id): \n\n\n\n[**status**](/glossary#status): \n\n\n\n[**when**](/glossary#when): 2020-01-27\n\n\n","success_response_body":{"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"}]}]},"error_response_bodies":["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."],"tags":["Customer-Meeting","Customer","Experimental"],"typed_success_response_body":{"type":"object","properties":{"meetings":{"type":"array","items":{"type":"object","properties":{"present":{"type":"object","properties":{"staff_user_id":{"type":"string"},"customer_user_id":{"type":"string"}}},"invitees":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"contact_details":{"type":"object","properties":{"name":{"type":"string"},"mobile_phone":{"type":"string"},"email_address":{"type":"string"}}}}}},"bank_id":{"type":"string"},"when":{"type":"string","format":"date-time"},"provider_id":{"type":"string"},"purpose_id":{"type":"string"},"keys":{"type":"object","properties":{"customer_token":{"type":"string"},"session_id":{"type":"string"},"staff_token":{"type":"string"}}},"creator":{"type":"object","properties":{"name":{"type":"string"},"mobile_phone":{"type":"string"},"email_address":{"type":"string"}}},"meeting_id":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/meetings","connector_methods":["obp.getMeetings","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-createMeeting","implemented_by":{"version":"OBPv3.1.0","function":"createMeeting"},"request_verb":"POST","request_url":"/obp/v3.1.0/banks/BANK_ID/meetings","summary":"Create Meeting (video conference/call)","description":"Create Meeting: Initiate a video conference/call with the bank.
\nThe Meetings resource contains meta data about video/other conference sessions
\nprovider_id determines the provider of the meeting / video chat service. MUST be url friendly (no spaces).
\npurpose_id explains the purpose of the chat. onboarding | mortgage | complaint etc. MUST be url friendly (no spaces).
\nLogin is required.
\nThis call is experimental. Currently staff_user_id is not set. Further calls will be needed to correctly set this.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\nJSON request body fields:
\n\n\ndate: 2020-01-27
\n\n\n\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\n\n\n\nkeys:
\n\n\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\nsession_id: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
\n\n\n\nwhen: 2020-01-27
\n","description_markdown":"Create Meeting: Initiate a video conference/call with the bank.\n\nThe Meetings resource contains meta data about video/other conference sessions\n\nprovider_id determines the provider of the meeting / video chat service. MUST be url friendly (no spaces).\n\npurpose_id explains the purpose of the chat. onboarding | mortgage | complaint etc. MUST be url friendly (no spaces).\n\nLogin is required.\n\nThis call is **experimental**. Currently staff_user_id is not set. Further calls will be needed to correctly set this.\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**contact_details**](/glossary#contact_details): \n\n\n\n[**creator**](/glossary#creator): \n\n\n\n[**date**](/glossary#): 2020-01-27\n\n\n\n[**email_address**](/glossary#email_address): \n\n\n\n[**invitees**](/glossary#invitees): \n\n\n\n[**mobile_phone**](/glossary#mobile_phone): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**purpose_id**](/glossary#purpose_id): \n\n\n\n[**status**](/glossary#status): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**contact_details**](/glossary#contact_details): \n\n\n\n[**creator**](/glossary#creator): \n\n\n\n[**customer_token**](/glossary#customer_token): \n\n\n\n[**customer_user_id**](/glossary#customer_user_id): \n\n\n\n[**email_address**](/glossary#email_address): \n\n\n\n[**invitees**](/glossary#invitees): \n\n\n\n[**keys**](/glossary#keys): \n\n\n\n[**meeting_id**](/glossary#meeting_id): \n\n\n\n[**mobile_phone**](/glossary#mobile_phone): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**present**](/glossary#present): \n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**purpose_id**](/glossary#purpose_id): \n\n\n\n[**session_id**](/glossary#): b4e0352a-9a0f-4bfa-b30b-9003aa467f50\n\n\n\n[**staff_token**](/glossary#staff_token): \n\n\n\n[**staff_user_id**](/glossary#staff_user_id): \n\n\n\n[**status**](/glossary#status): \n\n\n\n[**when**](/glossary#when): 2020-01-27\n\n\n","example_request_body":{"provider_id":"Chris","purpose_id":"String, eg: onboarding","date":"1100-01-01T01:01:01Z","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"}]},"success_response_body":{"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"}]},"error_response_bodies":["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."],"tags":["Customer-Meeting","Customer","Experimental"],"typed_request_body":{"type":"object","properties":{"invitees":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"contact_details":{"type":"object","properties":{"name":{"type":"string"},"mobile_phone":{"type":"string"},"email_address":{"type":"string"}}}}}},"provider_id":{"type":"string"},"purpose_id":{"type":"string"},"creator":{"type":"object","properties":{"name":{"type":"string"},"mobile_phone":{"type":"string"},"email_address":{"type":"string"}}},"date":{"type":"string","format":"date-time"}}},"typed_success_response_body":{"type":"object","properties":{"present":{"type":"object","properties":{"staff_user_id":{"type":"string"},"customer_user_id":{"type":"string"}}},"invitees":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"contact_details":{"type":"object","properties":{"name":{"type":"string"},"mobile_phone":{"type":"string"},"email_address":{"type":"string"}}}}}},"bank_id":{"type":"string"},"when":{"type":"string","format":"date-time"},"provider_id":{"type":"string"},"purpose_id":{"type":"string"},"keys":{"type":"object","properties":{"customer_token":{"type":"string"},"session_id":{"type":"string"},"staff_token":{"type":"string"}}},"creator":{"type":"object","properties":{"name":{"type":"string"},"mobile_phone":{"type":"string"},"email_address":{"type":"string"}}},"meeting_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/meetings","connector_methods":["obp.createMeeting","obp.getBank","obp.getBankAccountsForUser"]},{"operation_id":"OBPv3.1.0-getMeeting","implemented_by":{"version":"OBPv3.1.0","function":"getMeeting"},"request_verb":"GET","request_url":"/obp/v3.1.0/banks/BANK_ID/meetings/MEETING_ID","summary":"Get Meeting","description":"Get Meeting specified by BANK_ID / MEETING_ID
\nMeetings contain meta data about, and are used to facilitate, video conferences / chats etc.
The actual conference/chats are handled by external services.
\nLogin is required.
\nThis call is experimental and will require further authorisation in the future.
\nAuthentication is Mandatory
\nURL Parameters:
\nBANK_ID: gh.29.uk
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n\n\n\n\nkeys:
\n\n\nname: ACCOUNT_MANAGEMENT_FEE
\n\n\n\nsession_id: b4e0352a-9a0f-4bfa-b30b-9003aa467f50
\n\n\n\nwhen: 2020-01-27
\n","description_markdown":"Get Meeting specified by BANK_ID / MEETING_ID\nMeetings contain meta data about, and are used to facilitate, video conferences / chats etc.\n\nThe actual conference/chats are handled by external services.\n\nLogin is required.\n\nThis call is **experimental** and will require further authorisation in the future.\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[BANK_ID](/glossary#Bank.bank_id): gh.29.uk\n\n\n\n[MEETING_ID](/glossary#meeting_id): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**contact_details**](/glossary#contact_details): \n\n\n\n[**creator**](/glossary#creator): \n\n\n\n[**customer_token**](/glossary#customer_token): \n\n\n\n[**customer_user_id**](/glossary#customer_user_id): \n\n\n\n[**email_address**](/glossary#email_address): \n\n\n\n[**invitees**](/glossary#invitees): \n\n\n\n[**keys**](/glossary#keys): \n\n\n\n[**meeting_id**](/glossary#meeting_id): \n\n\n\n[**mobile_phone**](/glossary#mobile_phone): \n\n\n\n[**name**](/glossary#name): ACCOUNT_MANAGEMENT_FEE\n\n\n\n[**present**](/glossary#present): \n\n\n\n[**provider_id**](/glossary#provider_id): \n\n\n\n[**purpose_id**](/glossary#purpose_id): \n\n\n\n[**session_id**](/glossary#): b4e0352a-9a0f-4bfa-b30b-9003aa467f50\n\n\n\n[**staff_token**](/glossary#staff_token): \n\n\n\n[**staff_user_id**](/glossary#staff_user_id): \n\n\n\n[**status**](/glossary#status): \n\n\n\n[**when**](/glossary#when): 2020-01-27\n\n\n","success_response_body":{"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"}]},"error_response_bodies":["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."],"tags":["Customer-Meeting","Customer","Experimental"],"typed_success_response_body":{"type":"object","properties":{"present":{"type":"object","properties":{"staff_user_id":{"type":"string"},"customer_user_id":{"type":"string"}}},"invitees":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"contact_details":{"type":"object","properties":{"name":{"type":"string"},"mobile_phone":{"type":"string"},"email_address":{"type":"string"}}}}}},"bank_id":{"type":"string"},"when":{"type":"string","format":"date-time"},"provider_id":{"type":"string"},"purpose_id":{"type":"string"},"keys":{"type":"object","properties":{"customer_token":{"type":"string"},"session_id":{"type":"string"},"staff_token":{"type":"string"}}},"creator":{"type":"object","properties":{"name":{"type":"string"},"mobile_phone":{"type":"string"},"email_address":{"type":"string"}}},"meeting_id":{"type":"string"}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v5.0.0/banks/BANK_ID/meetings/MEETING_ID","connector_methods":["obp.getMeeting","obp.getBank","obp.getBankAccountsForUser"]}]}