Integrations

Manage integrations.

Retrieve global Microsoft 365 provisioning details

get

Retrieve details of global Microsoft 365 settings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

national_cloudstring · enumOptional

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.

Default: GLOBALPossible values:

directory_idstringOptional

The Directory ID (Tenant ID) of Microsoft identity platform.

application_idstringOptional

The Application (client) ID of Azure AD.

redirect_uristringRead-onlyOptional

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.

sbc_redirect_uristringRead-onlyOptional

Same as the redirect_uri, but via the sbc network topology.

4XX

Error

get/admin/ms365

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": ""
}

Reprovision global Microsoft 365 integration.

post

Update global Microsoft 365 settings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

national_cloudstring · enumOptional

GLOBAL: Azure global service.
CHINA: Azure China service.

Default: GLOBALPossible values:

directory_idstringOptional

The Directory ID (Tenant ID) of Microsoft identity platform.

application_idstringOptional

The Application (client) ID of Azure AD.

Responses

200

No content

4XX

Error

post/admin/ms365

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

get

Download global Microsoft 365 certificate.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/octet-stream

Responsestring · binary

4XX

Error

get/admin/ms365/certificate

GET /api/admin/ms365/certificate HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Generate new global Microsoft 365 certificate

post

Generate new global Microsoft 365 certificate.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/octet-stream

Responsestring · binary

4XX

Error

post/admin/ms365/certificate

POST /api/admin/ms365/certificate HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Retrieve global Google integrations

get

Retrieve details of global Google integrations settings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

client_idstringOptional

The client ID of Google Cloud project.

client_secretstringOptional

The client secret of Google Cloud project.

redirect_uristringRead-onlyOptional

sbc_redirect_uristringRead-onlyOptional

Same as the redirect_uri, but via the sbc network topology.

auth_consent_uristringRead-onlyOptional

The Google OAuth2 consent uri.

4XX

Error

get/admin/google

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.

post

Update global Google integration settings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

client_idstringOptional

The client ID of Google Cloud project.

client_secretstringOptional

The client secret of Google Cloud project.

Responses

200

No content

4XX

Error

post/admin/google

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

post

Delete global Google integration settings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

No content

4XX

Error

post/admin/google/destroy

POST /api/admin/google/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete global Microsoft 365 integration

post

Delete global Microsoft 365 integration settings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

No content

4XX

Error

post/admin/ms365/destroy

POST /api/admin/ms365/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Retrieve tenant Microsoft 365 provisioning details

get

Retrieve details of tenant Microsoft 365 settings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

national_cloudstring · enumOptional

GLOBAL: Azure global service.
CHINA: Azure China service.

Default: GLOBALPossible values:

directory_idstringOptional

The Directory ID (Tenant ID) of Microsoft identity platform.

application_idstringOptional

The Application (client) ID of Azure AD.

redirect_uristringRead-onlyOptional

sbc_redirect_uristringRead-onlyOptional

Same as the redirect_uri, but via the sbc network topology.

sync_timestringOptional

The crontab expression https://en.wikipedia.org/wiki/Cron

groupsstring[]Optional

A collection of Microsoft 365 groups to sync.

4XX

Error

get/ms365

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"
  }
}

Reprovision tenant Microsoft 365 integration.

post

Update tenant Microsoft 365 settings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

national_cloudstring · enumOptional

GLOBAL: Azure global service.
CHINA: Azure China service.

Default: GLOBALPossible values:

directory_idstringOptional

The Directory ID (Tenant ID) of Microsoft identity platform.

application_idstringOptional

The Application (client) ID of Azure AD.

sync_timestringOptional

The crontab expression https://en.wikipedia.org/wiki/Cron

groupsstring[]Optional

A collection of Microsoft 365 groups to sync.

Responses

200

No content

4XX

Error

post/ms365

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

get

Download Microsoft 365 certificate.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/octet-stream

Responsestring · binary

4XX

Error

get/ms365/certificate

GET /api/ms365/certificate HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Generate new Microsoft 365 certificate

post

Generate new Microsoft 365 certificate.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/octet-stream

Responsestring · binary

4XX

Error

post/ms365/certificate

POST /api/ms365/certificate HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Retrieve a collection of Microsoft 365 users

get

Retrieve a collection of Microsoft 365 users.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get/ms365/users

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 Microsoft 365 users by type

get

List users from Microsoft 365 by user type.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

typestring · enumRequiredPossible values:

Query parameters

topinteger · min: 1 · max: 100Optional

The maximum number of items to return

searchstringOptional

Search for users by name, email, or other fields

skiptokenstringOptional

Token for pagination

groupstringOptional

Group ID to filter users by group membership

Responses

200

application/json

countinteger · int64Optional

4XX

Error

get/ms365/users/{type}

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 MS365 groups

get

List all MS365 groups

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

$topinteger · min: 1 · max: 100Optional

Number of items to return per page

Default: 100

skiptokenstringOptional

Skip token for pagination

searchstringOptional

Search for groups by displayName or mail

Responses

200

application/json

401

Unauthorized

403

Forbidden

500

Internal server error

get/ms365/groups

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

post

Bulk get MS365 groups by IDs

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

idsstring[]Optional

Responses

200

application/json

countinteger · int64Optional

400

Bad request

401

Unauthorized

403

Forbidden

500

Internal server error

post/ms365/groups/get_many

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 MS365 group members

get

List members of a specific MS365 group

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the MS365 group

typestring · enumRequired

Type of members to list

Possible values:

Query parameters

$topinteger · min: 1 · max: 100Optional

Number of items to return per page

Default: 100

skiptokenstringOptional

Skip token for pagination

Responses

200

application/json

401

Unauthorized

403

Forbidden

404

Group not found

500

Internal server error

get/ms365/groups/{id}/{type}

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 MS365 integration

post

Delete a certain MS365 integration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

No content

4XX

Error

post/ms365/destroy

POST /api/ms365/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Retrieve tenant Google integrations

get

Retrieve details of tenant Google integrations settings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

client_idstringOptional

The client ID of Google Cloud project.

client_secretstringOptional

The client secret of Google Cloud project.

redirect_uristringRead-onlyOptional

sbc_redirect_uristringRead-onlyOptional

Same as the redirect_uri, but via the sbc network topology.

auth_consent_uristringRead-onlyOptional

The Google OAuth2 consent uri.

sync_timestringOptional

The time at which the synchronization should be performed, using cron syntax. Defaults to '0 0 * * *' (midnight every day).

4XX

Error

get/google

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.

post

Update tenant Google integration settings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

client_idstringOptional

The client ID of Google Cloud project.

client_secretstringOptional

The client secret of Google Cloud project.

sync_timestringOptional

The time at which the synchronization should be performed, using cron syntax. Defaults to '0 0 * * *' (midnight every day).

Responses

200

No content

4XX

Error

post/google

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 Google users

get

List users from Google Workspace.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

typestring · enumRequiredPossible values:

Query parameters

topinteger · min: 1 · max: 100Optional

The maximum number of items to return

searchstringOptional

Search for users by name, email, or other fields

skiptokenstringOptional

Token for pagination

Responses

200

application/json

countinteger · int64Optional

4XX

Error

get/google/users/{type}

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 Google user details

get

Get detailed information about a specific Google Workspace user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The user ID of the Google account.

Responses

200

application/json

idstringOptional

namestringOptional

emailstringOptional

principal_namestringOptional

4XX

Error

get/google/users/details/{id}

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 Google directory contacts

get

List all Google directory contacts.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

Google directory contact details.

idstringOptional

The contact ID (without people/ prefix).

namestringOptional

The contact name.

emailstringOptional

The contact email.

principal_namestringOptional

The contact principal name (usually the same as email).

4XX

Error

get/google/directory

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 Google directory contact details

get

Get details of a Google directory contact by ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Contact ID

Responses

200

application/json

Google directory contact details.

idstringOptional

The contact ID (without people/ prefix).

namestringOptional

The contact name.

emailstringOptional

The contact email.

principal_namestringOptional

The contact principal name (usually the same as email).

4XX

Error

get/google/directory/{id}

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 Google integration

post

Delete a certain Google integration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

No content

4XX

Error

post/google/destroy

POST /api/google/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Bulk get Google directory contacts

post

Bulk get details of Google directory contacts by IDs.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

idsstring[] · min: 1 · max: 100Required

List of contact IDs

Responses

200

application/json

4XX

Error

post/google/directory/get_many

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

post

Generate Google authorization URL for tenant

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

client_idstringRequired

Google client ID

client_secretstringRequired

Google client secret

callback_urlstringOptional

Callback URL after authorization

Responses

200

application/json

auth_consent_uristringOptional

Google authorization URL

400

Bad request

401

Unauthorized

403

Forbidden

409

Client ID already exists

500

Internal server error

post/google/authorization

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"
}

Get CRM integration

get

Retrieve details of tenant CRM integration configurations.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

providerstringOptional

The CRM provider.
Such as zoho, hubspot.

optsone ofOptional

4XX

Error

get/crm

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 CRM integration

post

Update tenant CRM integration configurations.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

providerstringRequired

The CRM provider.
Such as zoho, hubspot.

optsone ofRequired

Responses

200

No content

4XX

Error

post/crm

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

List available providers

get

Retrieve all of available providers.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

4XX

Error

get/crm/providers

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"
    }
  ]
}

Get CRM provider information.

get

Retrieve CRM provider information by name.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

providerstringRequired

The CRM provider.
Such as zoho, hubspot.

Responses

200

application/json

stringOptional

4XX

Error

get/crm/providers/{provider}

GET /api/crm/providers/{provider} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

Test integration

post

Try to search contacts in CRM integration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

numberstring · max: 128Required

The business phone number of contact.

Responses

200

application/json

4XX

Error

post/crm/test

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"
    }
  ]
}

List contacts

get

Retrieve a collection of CRM contacts.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0

topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100

Responses

200

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get/crm/contacts

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

post

Create a contact into specified CRM integration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

first_namestring · min: 1 · max: 64Optional

The first name of contact.

last_namestring · min: 1 · max: 64Required

The last name of contact.

emailstring · max: 128Optional

The email of contact.

companystring · max: 128Optional

The company name of contact.

titlestring · max: 128Optional

The title of contact.

businessstring · max: 128Optional

The business phone number of contact.

business2string · max: 128Optional

The secondary business phone number of contact.

mobile_phonestring · max: 128Optional

The mobile phone number of contact.

mobile_phone2string · max: 128Optional

The secondary mobile phone number of contact.

home_phonestring · max: 128Optional

The home phone number of contact.

home_phone2string · max: 128Optional

The secondary home phone number of contact.

otherstring · max: 128Optional

The other phone number of contact.

business_faxstring · max: 128Optional

The business fax of contact.

home_faxstring · max: 128Optional

The home fax of contact.

addressstring · max: 128Optional

The address.

notesstring · max: 1024Optional

The notes of contact.

did_numberstringRequired

The DID/DDI number.

Responses

201

Created

application/json

idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

4XX

Error

post/crm/contacts

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 contacts

post

Search CRM contacts with specified conditions in CRM integration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

numberstring · max: 128Required

The business phone number of contact.

Responses

200

application/json

4XX

Error

post/crm/contacts/search

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"
    }
  ]
}

Get a CRM contact

get

Retrieve CRM contact details by it's ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

application/json

idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

first_namestring · min: 1 · max: 64Optional

The first name of contact.

last_namestring · min: 1 · max: 64Optional

The last name of contact.

emailstring · max: 128Optional

The email of contact.

companystring · max: 128Optional

The company name of contact.

titlestring · max: 128Optional

The title of contact.

did_numberstringOptional

The DID/DDI number.

businessstring · max: 128Optional

The business phone number of contact.

business2string · max: 128Optional

The secondary business phone number of contact.

mobile_phonestring · max: 128Optional

The mobile phone number of contact.

mobile_phone2string · max: 128Optional

The secondary mobile phone number of contact.

home_phonestring · max: 128Optional

The home phone number of contact.

home_phone2string · max: 128Optional

The secondary home phone number of contact.

otherstring · max: 128Optional

The other phone number of contact.

business_faxstring · max: 128Optional

The business fax of contact.

home_faxstring · max: 128Optional

The home fax of contact.

addressstring · max: 128Optional

The address.

notesstring · max: 1024Optional

The notes of contact.

typestringOptional

The type of contact.

urlstringOptional

The access URL of contact.

4XX

Error

get/crm/contacts/{id}

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

post

Update a CRM contact.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Body

first_namestring · min: 1 · max: 64Optional

The first name of contact.

last_namestring · min: 1 · max: 64Optional

The last name of contact.

emailstring · max: 128Optional

The email of contact.

companystring · max: 128Optional

The company name of contact.

titlestring · max: 128Optional

The title of contact.

did_numberstringOptional

The DID/DDI number.

businessstring · max: 128Optional

The business phone number of contact.

business2string · max: 128Optional

The secondary business phone number of contact.

mobile_phonestring · max: 128Optional

The mobile phone number of contact.

mobile_phone2string · max: 128Optional

The secondary mobile phone number of contact.

home_phonestring · max: 128Optional

The home phone number of contact.

home_phone2string · max: 128Optional

The secondary home phone number of contact.

otherstring · max: 128Optional

The other phone number of contact.

business_faxstring · max: 128Optional

The business fax of contact.

home_faxstring · max: 128Optional

The home fax of contact.

addressstring · max: 128Optional

The address.

notesstring · max: 1024Optional

The notes of contact.

Responses

200

No content

4XX

Error

post/crm/contacts/{id}

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

Delete a CRM contact

post

Remove CRM contact by it's ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

202

No Content

No content

4XX

Error

post/crm/contacts/{id}/destroy

POST /api/crm/contacts/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List contact notes

get

List a collection of CRM contact notes.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the CRM contact.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get/crm/contacts/{id}/notes

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

post

Create CRM contact note.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Body

titlestringOptional

The title of CRM record note.

contentstringOptional

The content of CRM record note.

Responses

200

application/json

idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

4XX

Error

post/crm/contacts/{id}/notes

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 contact note

get

Get CRM contact note.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the CRM contact.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

note_idstringRequired

The unique ID of the CRM note.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

application/json

idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

titlestringOptional

The title of CRM record note.

contentstringOptional

The content of CRM record note.

created_atstring · date_timeOptional

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

Example: 2017-07-21T17:32:28Z

updated_atstring · date_timeOptional

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

Example: 2017-07-21T17:32:28Z

4XX

Error

get/crm/contacts/{id}/notes/{note_id}

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

post

Update CRM contact note.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the contact.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

note_idstringRequired

The unique ID of the CRM note.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

titlestringOptional

The title of CRM record note.

contentstringOptional

The content of CRM record note.

Responses

200

No content

4XX

Error

post/crm/contacts/{id}/notes/{note_id}

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

post

Delete CRM contact note.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the contact.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

note_idstringRequired

The unique ID of the CRM note.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No content

4XX

Error

post/crm/contacts/{id}/notes/{note_id}/destroy

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

get

List calls from CRM integration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Query parameters

filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0

topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100

countbooleanOptional

Use the $count=true query option to include a count of entities that match the filter criteria.

Default: false

Responses

200

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get/crm/contacts/{id}/calls

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

get

Get call from CRM integration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

call_idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

application/json

idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

callerstring · max: 256Optional

The caller number of the call.

caller_display_namestring · max: 1024Optional

The caller display name of the call.

calleestring · max: 256Optional

The callee number of the call.

callee_display_namestring · max: 1024Optional

The callee display name of the call.

started_atstring · date_timeOptional

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

Example: 2017-07-21T17:32:28Z

rang_atstring · date_timeOptional

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

Example: 2017-07-21T17:32:28Z

answered_atstring · date_timeOptional

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

Example: 2017-07-21T17:32:28Z

ended_atstring · date_timeOptional

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

Example: 2017-07-21T17:32:28Z

directionstring · enumOptional

The direction of CDR:

INBOUND_CALL:
OUTBOUND_CALL:

Possible values:

durationinteger · int32Optional

The total talk time for a session (in seconds).

summarystringOptional

The summary of CRM call.

transcriptionstringOptional

The transcription of CRM call.

recordingstringOptional

The recording of CRM call.

4XX

Error

get/crm/contacts/{id}/calls/{call_id}

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 call

post

Update CRM call summary.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

call_idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Body

summarystringRequired

The summary of CRM call.

Responses

200

No content

4XX

Error

post/crm/contacts/{id}/calls/{call_id}

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

PreviousTroubleshooting NextDataflow

Last updated 20 days ago

Was this helpful?