Integrations | PortSIP Knowledge Base

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

OK

application/json

4XX

Error

get

/admin/ms365

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

{
  "national_cloud": null,
  "directory_id": null,
  "application_id": null,
  "redirect_uri": null,
  "sbc_redirect_uri": null
}

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

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.

Responses

200

OK

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": null,
  "directory_id": null,
  "application_id": null
}

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

OK

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

OK

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

OK

application/json

4XX

Error

get

/admin/google

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

{
  "client_id": null,
  "client_secret": null,
  "redirect_uri": null,
  "sbc_redirect_uri": null,
  "auth_consent_uri": null
}

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

OK

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: 39

{
  "client_id": null,
  "client_secret": null
}

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

OK

application/json

4XX

Error

get

/ms365

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

{
  "national_cloud": null,
  "directory_id": null,
  "application_id": null,
  "redirect_uri": null,
  "sbc_redirect_uri": null,
  "sync_time": null,
  "users": null,
  "sign_in_as_administrator": null,
  "sign_in_as_standard_user": null,
  "personal_contacts": null,
  "shared_mailbox": null,
  "events": null
}

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

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.

sync_timestringOptional

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

Responses

200

OK

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: 220

{
  "national_cloud": null,
  "directory_id": null,
  "application_id": null,
  "sync_time": null,
  "users": null,
  "sign_in_as_administrator": null,
  "sign_in_as_standard_user": null,
  "personal_contacts": null,
  "shared_mailbox": null,
  "events": null
}

No content

Download Microsoft 365 certificate

get

Download Microsoft 365 certificate.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

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

OK

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

OK

application/json

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": null,
      "name": null,
      "email": null
    }
  ]
}

Retrieve tenant Google integrations

get

Retrieve details of tenant Google integrations settings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/google

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

{
  "client_id": null,
  "client_secret": null,
  "redirect_uri": null,
  "sbc_redirect_uri": null,
  "auth_consent_uri": null
}

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.

Responses

200

OK

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: 39

{
  "client_id": null,
  "client_secret": null
}

No content

Get CRM integration

get

Retrieve details of tenant CRM integration configurations.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/crm

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

{
  "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,
    "redirect_url": "https://example.com/callback/zoho",
    "sbc_redirect_url": "https://example.com/callback/zoho",
    "refresh_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

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

or

Responses

200

OK

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

OK

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

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

OK

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": null,
      "first_name": null,
      "last_name": null,
      "email": null,
      "company": null,
      "title": null,
      "did_number": null,
      "business": null,
      "business2": null,
      "mobile_phone": null,
      "mobile_phone2": null,
      "home_phone": null,
      "home_phone2": null,
      "other": null,
      "business_fax": null,
      "home_fax": null,
      "address": null,
      "notes": null,
      "type": null,
      "url": null
    }
  ]
}

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

OK

application/json

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": null,
      "first_name": null,
      "last_name": null,
      "email": null,
      "company": null,
      "title": null,
      "did_number": null,
      "business": null,
      "business2": null,
      "mobile_phone": null,
      "mobile_phone2": null,
      "home_phone": null,
      "home_phone2": null,
      "other": null,
      "business_fax": null,
      "home_fax": null,
      "address": null,
      "notes": null,
      "type": null,
      "url": null
    }
  ]
}

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

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: 263

{
  "name": null,
  "email": null,
  "company": null,
  "title": null,
  "business": null,
  "business2": null,
  "mobile_phone": null,
  "mobile_phone2": null,
  "home_phone": null,
  "home_phone2": null,
  "other": null,
  "business_fax": null,
  "home_fax": null,
  "address": null,
  "notes": null,
  "did": "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

OK

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": null,
      "first_name": null,
      "last_name": null,
      "email": null,
      "company": null,
      "title": null,
      "did_number": null,
      "business": null,
      "business2": null,
      "mobile_phone": null,
      "mobile_phone2": null,
      "home_phone": null,
      "home_phone2": null,
      "other": null,
      "business_fax": null,
      "home_fax": null,
      "address": null,
      "notes": null,
      "type": null,
      "url": null
    }
  ]
}

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

idall ofRequired

The unique ID of contact.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/crm/contacts/{id}

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

{
  "id": null,
  "first_name": null,
  "last_name": null,
  "email": null,
  "company": null,
  "title": null,
  "did_number": null,
  "business": null,
  "business2": null,
  "mobile_phone": null,
  "mobile_phone2": null,
  "home_phone": null,
  "home_phone2": null,
  "other": null,
  "business_fax": null,
  "home_fax": null,
  "address": null,
  "notes": null,
  "type": null,
  "url": null
}

Update a CRM contact

post

Update a CRM contact.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of contact.

stringOptional

The unique ID of the resource.

Example: 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

OK

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: 283

{
  "first_name": null,
  "last_name": null,
  "email": null,
  "company": null,
  "title": null,
  "did_number": null,
  "business": null,
  "business2": null,
  "mobile_phone": null,
  "mobile_phone2": null,
  "home_phone": null,
  "home_phone2": null,
  "other": null,
  "business_fax": null,
  "home_fax": null,
  "address": null,
  "notes": null
}

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

idall ofRequired

The unique ID of contact.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

202

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 resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

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": "",
      "updated_at": ""
    },
    {
      "id": "",
      "title": "",
      "content": "",
      "created_at": "",
      "updated_at": ""
    }
  ]
}

Create CRM contact note

post

Create CRM contact note.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of contact.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

titlestringOptional

The title of CRM record note.

contentstringOptional

The content of CRM record note.

Responses

200

OK

application/json

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 resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

note_idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

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": "",
  "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 resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

note_idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

titlestringOptional

The title of CRM record note.

contentstringOptional

The content of CRM record note.

Responses

200

OK

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 resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

note_idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

OK

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

idall ofRequired

The unique ID of contact.

stringOptional

The unique ID of the resource.

Example: 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

OK

application/json

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": null,
      "caller": null,
      "caller_display_name": null,
      "callee": null,
      "callee_display_name": null,
      "started_at": null,
      "rang_at": null,
      "answered_at": null,
      "ended_at": null,
      "direction": null,
      "duration": null,
      "summary": null,
      "transcription": null,
      "recording": null
    }
  ]
}

Get call

get

Get call from CRM integration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of contact.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

call_idall ofRequired

The unique ID of CRM call.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

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": null,
  "session_id": null,
  "caller": null,
  "caller_display_name": null,
  "callee": null,
  "callee_display_name": null,
  "started_at": null,
  "rang_at": null,
  "answered_at": null,
  "ended_at": null,
  "direction": null,
  "duration": null,
  "summary": null,
  "transcription": null,
  "recording": null
}

Update call

post

Update CRM call summary.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of contact.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

call_idall ofRequired

The unique ID of CRM call.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

summarystringRequired

The summary of CRM call.

Responses

200

OK

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: 16

{
  "summary": null
}

No content