Integrations
Manage integrations.
Retrieve details of global Microsoft 365 settings.
OK
The Microsoft cloud services are available in several separate national clouds.
These national cloud versions are physical and logical network-isolated instances of Microsoft enterprise cloud services
that are confined within the geographic borders of specific countries and operated by local personnel.
Can be either:
GLOBAL: Azure global service.CHINA: Azure China service.
GLOBALPossible values: The Directory ID (Tenant ID) of Microsoft identity platform.
The Application (client) ID of Azure AD.
Redirect URI. The URIs we will accept as destinations when returning authentication responses (tokens) after successfully authenticating or signing out users.
The redirect URI you send in the request to the login server should match one listed here. Also referred to as reply URLs.
Same as the redirect_uri, but via the sbc network topology.
Error
GET /api/admin/ms365 HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"national_cloud": "GLOBAL",
"directory_id": "",
"application_id": "",
"redirect_uri": "",
"sbc_redirect_uri": ""
}Update global Microsoft 365 settings.
The Microsoft cloud services are available in several separate national clouds.
These national cloud versions are physical and logical network-isolated instances of Microsoft enterprise cloud services
that are confined within the geographic borders of specific countries and operated by local personnel.
Can be either:
GLOBAL: Azure global service.CHINA: Azure China service.
GLOBALPossible values: The Directory ID (Tenant ID) of Microsoft identity platform.
The Application (client) ID of Azure AD.
OK
No content
Error
POST /api/admin/ms365 HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"national_cloud": "GLOBAL",
"directory_id": "",
"application_id": ""
}No content
Download global Microsoft 365 certificate.
OK
Error
GET /api/admin/ms365/certificate HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
binaryGenerate new global Microsoft 365 certificate.
OK
Error
POST /api/admin/ms365/certificate HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
binaryRetrieve details of global Google integrations settings.
OK
The client ID of Google Cloud project.
The client secret of Google Cloud project.
Redirect URI. The URIs we will accept as destinations when returning authentication responses (tokens) after successfully authenticating or signing out users.
The redirect URI you send in the request to the login server should match one listed here. Also referred to as reply URLs.
Same as the redirect_uri, but via the sbc network topology.
The Google OAuth2 consent uri.
Error
GET /api/admin/google HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"client_id": "",
"client_secret": "",
"redirect_uri": "",
"sbc_redirect_uri": "",
"auth_consent_uri": ""
}Update global Google integration settings.
The client ID of Google Cloud project.
The client secret of Google Cloud project.
OK
No content
Error
POST /api/admin/google HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35
{
"client_id": "",
"client_secret": ""
}No content
Delete global Google integration settings.
OK
No content
Error
POST /api/admin/google/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Delete global Microsoft 365 integration settings.
OK
No content
Error
POST /api/admin/ms365/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Retrieve details of tenant Microsoft 365 settings.
OK
The Microsoft cloud services are available in several separate national clouds.
These national cloud versions are physical and logical network-isolated instances of Microsoft enterprise cloud services
that are confined within the geographic borders of specific countries and operated by local personnel.
Can be either:
GLOBAL: Azure global service.CHINA: Azure China service.
GLOBALPossible values: The Directory ID (Tenant ID) of Microsoft identity platform.
The Application (client) ID of Azure AD.
Redirect URI. The URIs we will accept as destinations when returning authentication responses (tokens) after successfully authenticating or signing out users.
The redirect URI you send in the request to the login server should match one listed here. Also referred to as reply URLs.
Same as the redirect_uri, but via the sbc network topology.
The crontab expression https://en.wikipedia.org/wiki/Cron
A collection of Microsoft 365 groups to sync.
Error
GET /api/ms365 HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"national_cloud": "GLOBAL",
"directory_id": "a5c8bb47-7b13-4cc6-aca0-4fd71635f301",
"application_id": "a5c8bb47-7b13-4cc6-aca0-4fd71635f301",
"redirect_uri": "https://examples.com",
"sbc_redirect_uri": "",
"sync_time": "0 0 * * *",
"users": {
"enabled": true,
"sync_guest_users": false,
"sync_photo": false,
"starting_extension_number": "1000",
"selected_users": [],
"sync_type": "ALL"
},
"sign_in_as_standard_user": {
"enabled": true,
"selected_users": [],
"sync_type": "ALL"
},
"personal_contacts": {
"enabled": true,
"selected_users": [],
"sync_type": "ALL"
},
"shared_mailbox": {
"enabled": true,
"selected_users": [],
"sync_type": "ALL"
},
"events": {
"enabled": true,
"selected_users": [],
"sync_type": "ALL"
}
}Update tenant Microsoft 365 settings.
The Microsoft cloud services are available in several separate national clouds.
These national cloud versions are physical and logical network-isolated instances of Microsoft enterprise cloud services
that are confined within the geographic borders of specific countries and operated by local personnel.
Can be either:
GLOBAL: Azure global service.CHINA: Azure China service.
GLOBALPossible values: The Directory ID (Tenant ID) of Microsoft identity platform.
The Application (client) ID of Azure AD.
The crontab expression https://en.wikipedia.org/wiki/Cron
A collection of Microsoft 365 groups to sync.
OK
No content
Error
POST /api/ms365 HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 596
{
"national_cloud": "GLOBAL",
"directory_id": "a5c8bb47-7b13-4cc6-aca0-4fd71635f301",
"application_id": "a5c8bb47-7b13-4cc6-aca0-4fd71635f301",
"sync_time": "0 0 * * *",
"users": {
"enabled": true,
"sync_guest_users": false,
"sync_photo": false,
"starting_extension_number": "1000",
"selected_users": [],
"sync_type": "ALL"
},
"sign_in_as_standard_user": {
"enabled": true,
"selected_users": [],
"sync_type": "ALL"
},
"personal_contacts": {
"enabled": true,
"selected_users": [],
"sync_type": "ALL"
},
"shared_mailbox": {
"enabled": true,
"selected_users": [],
"sync_type": "ALL"
},
"events": {
"enabled": true,
"selected_users": [],
"sync_type": "ALL"
}
}No content
Download Microsoft 365 certificate.
OK
Error
GET /api/ms365/certificate HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
binaryGenerate new Microsoft 365 certificate.
OK
Error
POST /api/ms365/certificate HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
binaryRetrieve a collection of Microsoft 365 users.
OK
Total number of resource.
100Error
GET /api/ms365/users HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 1,
"items": [
{
"id": "xxxxxx",
"name": "example",
"email": ""
}
]
}List users from Microsoft 365 by user type.
The maximum number of items to return
Search for users by name, email, or other fields
Token for pagination
Group ID to filter users by group membership
OK
Error
GET /api/ms365/users/{type} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 1,
"items": [
{
"id": "xxxxxx",
"name": "example",
"email": ""
}
]
}List all MS365 groups
Number of items to return per page
100Skip token for pagination
Search for groups by displayName or mail
OK
Unauthorized
Forbidden
Internal server error
GET /api/ms365/groups HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 1,
"items": [
{
"id": "text",
"displayName": "text",
"mail": "text"
}
]
}Bulk get MS365 groups by IDs
OK
Bad request
Unauthorized
Forbidden
Internal server error
POST /api/ms365/groups/get_many HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"ids": [
"text"
]
}{
"count": 1,
"items": [
{
"id": "text",
"displayName": "text",
"mail": "text"
}
]
}List members of a specific MS365 group
The unique ID of the MS365 group
Type of members to list
Number of items to return per page
100Skip token for pagination
OK
Unauthorized
Forbidden
Group not found
Internal server error
GET /api/ms365/groups/{id}/{type} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 1,
"items": [
{
"id": "text",
"displayName": "text",
"mail": "text"
}
]
}Delete a certain MS365 integration.
OK
No content
Error
POST /api/ms365/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Retrieve details of tenant Google integrations settings.
OK
The client ID of Google Cloud project.
The client secret of Google Cloud project.
Redirect URI. The URIs we will accept as destinations when returning authentication responses (tokens) after successfully authenticating or signing out users.
The redirect URI you send in the request to the login server should match one listed here. Also referred to as reply URLs.
Same as the redirect_uri, but via the sbc network topology.
The Google OAuth2 consent uri.
The time at which the synchronization should be performed, using cron syntax. Defaults to '0 0 * * *' (midnight every day).
Error
GET /api/google HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"client_id": "xxxxxx",
"client_secret": "xxxxxx",
"redirect_uri": "https://example.com",
"sbc_redirect_uri": "https://example.com",
"auth_consent_uri": "https://example.com",
"sync_time": "0 0 * * *",
"users": {
"enabled": true,
"sync_photo": true,
"starting_extension_number": "2000",
"sync_type": "INCLUDE",
"selected_users": [
"12345",
"67890"
]
},
"sign_in_as_standard_user": {
"enabled": true,
"sync_type": "INCLUDE",
"selected_users": [
"12345",
"67890"
]
},
"directory_contacts": {
"enabled": true,
"sync_type": "INCLUDE",
"selected_contacts": [
"12345",
"67890"
]
}
}Update tenant Google integration settings.
The client ID of Google Cloud project.
The client secret of Google Cloud project.
The time at which the synchronization should be performed, using cron syntax. Defaults to '0 0 * * *' (midnight every day).
OK
No content
Error
POST /api/google HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 405
{
"client_id": "xxxxxx",
"client_secret": "xxxxxx",
"sync_time": "0 0 * * *",
"users": {
"enabled": true,
"sync_photo": true,
"starting_extension_number": "2000",
"sync_type": "INCLUDE",
"selected_users": [
"12345",
"67890"
]
},
"sign_in_as_standard_user": {
"enabled": true,
"sync_type": "INCLUDE",
"selected_users": [
"12345",
"67890"
]
},
"directory_contacts": {
"enabled": true,
"sync_type": "INCLUDE",
"selected_contacts": [
"12345",
"67890"
]
}
}No content
List users from Google Workspace.
The maximum number of items to return
Search for users by name, email, or other fields
Token for pagination
OK
Error
GET /api/google/users/{type} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 2,
"items": [
{
"id": "123456789",
"name": "John Doe",
"email": "john@example.com",
"principal_name": "john@example.com"
},
{
"id": "987654321",
"name": "Jane Smith",
"email": "jane@example.com",
"principal_name": "jane@example.com"
}
]
}Get detailed information about a specific Google Workspace user.
The user ID of the Google account.
OK
Error
GET /api/google/users/details/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "123456789",
"name": "John Doe",
"email": "john@example.com",
"principal_name": "john@example.com"
}List all Google directory contacts.
OK
Google directory contact details.
The contact ID (without people/ prefix).
The contact name.
The contact email.
The contact principal name (usually the same as email).
Error
GET /api/google/directory HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"id": "text",
"name": "text",
"email": "text",
"principal_name": "text"
}
]Get details of a Google directory contact by ID.
Contact ID
OK
Google directory contact details.
The contact ID (without people/ prefix).
The contact name.
The contact email.
The contact principal name (usually the same as email).
Error
GET /api/google/directory/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "text",
"name": "text",
"email": "text",
"principal_name": "text"
}Delete a certain Google integration.
OK
No content
Error
POST /api/google/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Bulk get details of Google directory contacts by IDs.
List of contact IDs
OK
Error
POST /api/google/directory/get_many HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"ids": [
"text"
]
}{
"items": [
{
"id": "text",
"name": "text",
"email": "text",
"principal_name": "text"
}
]
}Generate Google authorization URL for tenant
Google client ID
Google client secret
Callback URL after authorization
OK
Google authorization URL
Bad request
Unauthorized
Forbidden
Client ID already exists
Internal server error
POST /api/google/authorization HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"client_id": "text",
"client_secret": "text",
"callback_url": "text"
}{
"auth_consent_uri": "text"
}Retrieve details of tenant CRM integration configurations.
OK
The CRM provider.
Such as zoho, hubspot.
Error
GET /api/crm HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"provider": "zoho",
"opts": {
"client_id": "xxxxxx",
"client_secret": "xxxxxx",
"region": "United States",
"enable_create_contact": true,
"contact_created_as": "Contact",
"contact_lookup_order": [
"Contacts",
"Leads",
"Accounts"
],
"contact_lookup_condition": "Always",
"enable_call_logging": true,
"enable_call_recording_logging": true,
"secure_call_recording_logging": true,
"redirect_url": "https://example.com/callback/zoho",
"sbc_redirect_url": "https://example.com/callback/zoho",
"refresh_token": "xxxxxx"
}
}Update tenant CRM integration configurations.
The CRM provider.
Such as zoho, hubspot.
OK
No content
Error
POST /api/crm HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 399
{
"provider": "zoho",
"opts": {
"client_id": "xxxxxxxxxxxxxxxxxxxxxxxxxx",
"client_secret": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"region": "United States",
"enable_create_contact": true,
"contact_created_as": "Contact",
"contact_lookup_order": [
"Contacts",
"Leads",
"Accounts"
],
"contact_lookup_condition": "Always",
"enable_call_logging": true,
"enable_call_recording_logging": true,
"secure_call_recording_logging": true
}
}No content
Retrieve all of available providers.
OK
Error
GET /api/crm/providers HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"items": [
{
"provider": "zoho",
"redirect_url": "https://example.com/callback/zoho",
"sbc_redirect_url": "https://example.com/callback/zoho"
},
{
"provider": "hubspot",
"redirect_url": "https://example.com/callback/hubspot",
"sbc_redirect_url": "https://example.com/callback/hubspot"
},
{
"provider": "odoo"
}
]
}Retrieve CRM provider information by name.
The CRM provider.
Such as zoho, hubspot.
OK
Error
GET /api/crm/providers/{provider} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
textTry to search contacts in CRM integration.
The business phone number of contact.
OK
Error
POST /api/crm/test HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 25
{
"number": "666-666-6666"
}{
"items": [
{
"id": "xxxxxx",
"first_name": "example",
"last_name": "example",
"email": "",
"company": "",
"title": "",
"did_number": "1000",
"business": "",
"business2": "",
"mobile_phone": "",
"mobile_phone2": "",
"home_phone": "",
"home_phone2": "",
"other": "",
"business_fax": "",
"home_fax": "",
"address": "",
"notes": "",
"type": "",
"url": "https://example.com"
}
]
}Retrieve a collection of CRM contacts.
Use the filter query parameter to retrieve just a subset of a collection.
Use the search query parameter to restrict the results of a request to match a search criterion.
Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.
Use the skip query parameter to set the number of items to skip at the start of a collection.
0Use the top query parameter to specify the page size of the result set.
100OK
Total number of resource.
100Error
GET /api/crm/contacts HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 1,
"items": [
{
"id": "xxxxxx",
"first_name": "example",
"last_name": "example",
"email": "",
"company": "",
"title": "",
"did_number": "1000",
"business": "",
"business2": "",
"mobile_phone": "",
"mobile_phone2": "",
"home_phone": "",
"home_phone2": "",
"other": "",
"business_fax": "",
"home_fax": "",
"address": "",
"notes": "",
"type": "",
"url": "https://example.com"
}
]
}Create a contact into specified CRM integration.
The first name of contact.
The last name of contact.
The email of contact.
The company name of contact.
The title of contact.
The business phone number of contact.
The secondary business phone number of contact.
The mobile phone number of contact.
The secondary mobile phone number of contact.
The home phone number of contact.
The secondary home phone number of contact.
The other phone number of contact.
The business fax of contact.
The home fax of contact.
The address.
The notes of contact.
The DID/DDI number.
Created
NzAwNTUxOTA5NzczMTQ4MTYwError
POST /api/crm/contacts HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 294
{
"first_name": "example",
"last_name": "example",
"email": "example@example.com",
"company": "",
"title": "",
"business": "",
"business2": "",
"mobile_phone": "",
"mobile_phone2": "",
"home_phone": "",
"home_phone2": "",
"other": "",
"business_fax": "",
"home_fax": "",
"address": "",
"notes": "",
"did_number": "111-222-3333"
}{
"id": "xxxxxxxx"
}Search CRM contacts with specified conditions in CRM integration.
The business phone number of contact.
OK
Error
POST /api/crm/contacts/search HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 25
{
"number": "666-666-6666"
}{
"items": [
{
"id": "xxxxxx",
"first_name": "example",
"last_name": "example",
"email": "",
"company": "",
"title": "",
"did_number": "1000",
"business": "",
"business2": "",
"mobile_phone": "",
"mobile_phone2": "",
"home_phone": "",
"home_phone2": "",
"other": "",
"business_fax": "",
"home_fax": "",
"address": "",
"notes": "",
"type": "",
"url": "https://example.com"
}
]
}Retrieve CRM contact details by it's ID.
NzAwNTUxOTA5NzczMTQ4MTYwOK
NzAwNTUxOTA5NzczMTQ4MTYwThe first name of contact.
The last name of contact.
The email of contact.
The company name of contact.
The title of contact.
The DID/DDI number.
The business phone number of contact.
The secondary business phone number of contact.
The mobile phone number of contact.
The secondary mobile phone number of contact.
The home phone number of contact.
The secondary home phone number of contact.
The other phone number of contact.
The business fax of contact.
The home fax of contact.
The address.
The notes of contact.
The type of contact.
The access URL of contact.
Error
GET /api/crm/contacts/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "xxxxxx",
"first_name": "example",
"last_name": "example",
"email": "example@example.com",
"company": "",
"title": "",
"did_number": "000000",
"business": "",
"business2": "",
"mobile_phone": "",
"mobile_phone2": "",
"home_phone": "",
"home_phone2": "",
"other": "",
"business_fax": "",
"home_fax": "",
"address": "",
"notes": "",
"type": "",
"url": "https://example.com"
}Update a CRM contact.
NzAwNTUxOTA5NzczMTQ4MTYwThe first name of contact.
The last name of contact.
The email of contact.
The company name of contact.
The title of contact.
The DID/DDI number.
The business phone number of contact.
The secondary business phone number of contact.
The mobile phone number of contact.
The secondary mobile phone number of contact.
The home phone number of contact.
The secondary home phone number of contact.
The other phone number of contact.
The business fax of contact.
The home fax of contact.
The address.
The notes of contact.
OK
No content
Error
POST /api/crm/contacts/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 288
{
"first_name": "example",
"last_name": "example",
"email": "example@example.com",
"company": "",
"title": "",
"did_number": "000000",
"business": "",
"business2": "",
"mobile_phone": "",
"mobile_phone2": "",
"home_phone": "",
"home_phone2": "",
"other": "",
"business_fax": "",
"home_fax": "",
"address": "",
"notes": ""
}No content
Remove CRM contact by it's ID.
NzAwNTUxOTA5NzczMTQ4MTYwNo Content
No content
Error
POST /api/crm/contacts/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
List a collection of CRM contact notes.
The unique ID of the CRM contact.
NzAwNTUxOTA5NzczMTQ4MTYwOK
Total number of resource.
100Error
GET /api/crm/contacts/{id}/notes HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"items": [
{
"id": "",
"title": "",
"content": "",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": ""
},
{
"id": "",
"title": "",
"content": "",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": ""
}
]
}Create CRM contact note.
NzAwNTUxOTA5NzczMTQ4MTYwThe title of CRM record note.
The content of CRM record note.
OK
NzAwNTUxOTA5NzczMTQ4MTYwError
POST /api/crm/contacts/{id}/notes HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 25
{
"title": "",
"content": ""
}{
"id": "xxxxxxxx"
}Get CRM contact note.
The unique ID of the CRM contact.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of the CRM note.
NzAwNTUxOTA5NzczMTQ4MTYwOK
NzAwNTUxOTA5NzczMTQ4MTYwThe title of CRM record note.
The content of CRM record note.
The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
2017-07-21T17:32:28ZThe RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
2017-07-21T17:32:28ZError
GET /api/crm/contacts/{id}/notes/{note_id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "",
"title": "",
"content": "",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": ""
}Update CRM contact note.
The unique ID of the contact.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of the CRM note.
NzAwNTUxOTA5NzczMTQ4MTYwThe title of CRM record note.
The content of CRM record note.
OK
No content
Error
POST /api/crm/contacts/{id}/notes/{note_id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 25
{
"title": "",
"content": ""
}No content
Delete CRM contact note.
The unique ID of the contact.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of the CRM note.
NzAwNTUxOTA5NzczMTQ4MTYwOK
No content
Error
POST /api/crm/contacts/{id}/notes/{note_id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
List calls from CRM integration.
NzAwNTUxOTA5NzczMTQ4MTYwUse the filter query parameter to retrieve just a subset of a collection.
Use the search query parameter to restrict the results of a request to match a search criterion.
Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.
Use the skip query parameter to set the number of items to skip at the start of a collection.
0Use the top query parameter to specify the page size of the result set.
100Use the $count=true query option to include a count of entities that match the filter criteria.
falseOK
Total number of resource.
100Error
GET /api/crm/contacts/{id}/calls HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 1,
"items": [
{
"id": "xxxxxx",
"caller": "101",
"caller_display_name": "User 101",
"callee": "102",
"callee_display_name": "User 102",
"started_at": "2020-01-01T00:00:00Z",
"rang_at": "2020-01-01T00:00:00Z",
"answered_at": "2020-01-01T00:00:00Z",
"ended_at": "2020-01-01T00:00:00Z",
"direction": "INBOUND_CALL",
"duration": 60,
"summary": "",
"transcription": "",
"recording": ""
}
]
}Get call from CRM integration.
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwOK
NzAwNTUxOTA5NzczMTQ4MTYwThe caller number of the call.
The caller display name of the call.
The callee number of the call.
The callee display name of the call.
The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
2017-07-21T17:32:28ZThe RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
2017-07-21T17:32:28ZThe RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
2017-07-21T17:32:28ZThe RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
2017-07-21T17:32:28ZThe direction of CDR:
INBOUND_CALL:OUTBOUND_CALL:
The total talk time for a session (in seconds).
The summary of CRM call.
The transcription of CRM call.
The recording of CRM call.
Error
GET /api/crm/contacts/{id}/calls/{call_id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "xxxxxx",
"caller": "101",
"caller_display_name": "User 101",
"callee": "101",
"callee_display_name": "User 102",
"started_at": "2000-01-01T00:00:00Z",
"rang_at": "2000-01-01T00:00:00Z",
"answered_at": "2000-01-01T00:00:00Z",
"ended_at": "2000-01-01T00:00:00Z",
"direction": "INBOUND_CALL",
"duration": 3,
"summary": "",
"transcription": "",
"recording": ""
}Update CRM call summary.
NzAwNTUxOTA5NzczMTQ4MTYwNzAwNTUxOTA5NzczMTQ4MTYwThe summary of CRM call.
OK
No content
Error
POST /api/crm/contacts/{id}/calls/{call_id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 14
{
"summary": ""
}No content
Last updated
Was this helpful?