Sign in

v1

latestOpenAPI 3.0.02026-07-14362240.2 KB
external-lines

Create an external line

Creates a new external communication line for integrating with external messaging platforms or phone systems.

post/messenger/v1/external-lines

Request body

namestring required

The name of the external line

iconstring required

The icon of the external line

phoneNumberstring required

The phone number of the external line

externalIdstring required

The external id of the external line

Example request

{
  "name": "External line name",
  "icon": "https://external-line-icon.com/icon.png",
  "phoneNumber": "+1234567890",
  "externalId": "external-line-external-id"
}

Response

The created external line

idstring required

External line id

namestring required

External line name

iconstring required

External line icon

externalIdstring required

External line external id

timestampnumber required

External line timestamp

portalstring required

External line portal

phoneNumberstring required

External line phone number

Example response

{
  "id": "659ff121fd62e43063340f2f",
  "name": "Main line",
  "icon": "https://example.com/icon.png",
  "externalId": "externalId",
  "timestamp": 1620211200000,
  "portal": "portal",
  "phoneNumber": "+1234567890"
}