Phone number API

Always use the Copy icon in the example field when copying examples. Manual copy and paste is known to cause data format errors.

Get phone number information

Get information on a phone number provided by Symphony

get

Get information on a phone number provided by Symphony

Authorizations

AuthorizationstringRequired

HTTP header

Path parameters

phoneNumberstring · phoneRequired

Phone number provided by Symphony

Responses

200

Found phone number provided by Symphony

application/json

phoneNumberstringRequiredExample: 911234567890

subNetworkstringOptional

countrystringOptional

carrierstringOptional

providerstringOptional

statusstringOptional

404

Phone number not found

application/json

get/api/v1/customer/phone-number/{phoneNumber}

GET /api/v1/customer/phone-number/{phoneNumber} HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "phoneNumber": 911234567890,
  "subNetwork": "text",
  "country": "text",
  "carrier": "text",
  "provider": "text",
  "status": "text",
  "address": {
    "property": "Symphony",
    "line1": "980 Avenue de Roumanille",
    "line2": "Le Fairway, Bâtiment A",
    "city": "Biot",
    "state": "France",
    "zip": 6410,
    "zipPlusFour": 6410
  },
  "assignedTo": {
    "advisorSymphonyId": 911234567890,
    "advisorFirstName": "text",
    "advisorLastName": "text"
  }
}

Update phone number

Update a phone number

put

This endpoint allows to update an existing phone number.

Currently, the following operations are supported:

Unassign a phone number from an advisor (making it "on hold").
Assign a phone number to a new advisor.

Authorizations

AuthorizationstringRequired

HTTP header

Path parameters

phoneNumberstring · phoneRequired

The phone number to update.

Body

Responses

200

The phone number was successfully updated.

application/json

phoneNumberstringRequiredExample: 911234567890

subNetworkstringOptional

countrystringOptional

carrierstringOptional

providerstringOptional

statusstringOptional

400

The advisor that the phone number is being associated to does not exist.

application/json

403

It is forbidden to update this phone number. This may happen if:

The advisor associated with the phone number is still entitled to a direct EMP,
The advisor that the phone number is being associated to is already entitled to a direct EMP with another phone number.

application/json

404

May happen if the phone number to update was not found.

application/json

put/api/v1/customer/phone-number/{phoneNumber}

PUT /api/v1/customer/phone-number/{phoneNumber} HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "assignedTo": {
    "advisorSymphonyId": 911234567890
  }
}

{
  "phoneNumber": 911234567890,
  "subNetwork": "text",
  "country": "text",
  "carrier": "text",
  "provider": "text",
  "status": "text",
  "address": {
    "property": "Symphony",
    "line1": "980 Avenue de Roumanille",
    "line2": "Le Fairway, Bâtiment A",
    "city": "Biot",
    "state": "France",
    "zip": 6410,
    "zipPlusFour": 6410
  },
  "assignedTo": {
    "advisorSymphonyId": 911234567890,
    "advisorFirstName": "text",
    "advisorLastName": "text"
  }
}

Get phone number details

get

Get phone numbers.

Authorizations

AuthorizationstringRequired

HTTP header

Query parameters

statusstringOptional

filter on the phone number status either

USED
FREE
RELEASED
ON_HOLD

providerstringOptional

filter on the provider

UMONY
CUSTOMER_SUPPLIED

productstringOptional

filter on the product

VOICE
SMS
PRE_ALLOCATED_NUMBER
PRE_ALLOCATED_FULL
SECOND_NUMBER
SECOND_NUMBER_FULL

subNetworkstringOptional

filter on the subnetwork:

SECOND-NUMBER
IN-NETWORK

Responses

200

Request processed

application/json

get/api/v1/customer/phone-numbers

GET /api/v1/customer/phone-numbers HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Request processed

{
  "numbers": [
    {
      "phoneNumber": 911234567890,
      "subNetwork": "text",
      "country": "text",
      "carrier": "text",
      "status": "text",
      "productCode": 1,
      "product": "text",
      "provider": "UMONY",
      "assignedTo": {
        "advisorSymphonyId": 911234567890,
        "advisorFirstName": "text",
        "advisorLastName": "text"
      },
      "externalNetworks": [
        {
          "externalNetwork": "WHATSAPP-DIRECT",
          "availability": "text",
          "empStatus": "CONNECTED"
        }
      ]
    }
  ]
}

Get phone number address

Get phone address

get

Get phone address

Authorizations

AuthorizationstringRequired

HTTP header

Path parameters

phoneNumberstring · phoneRequired

Phone number

Responses

200

Found phone address

application/json

propertystringOptionalExample: Symphony

line1stringOptionalExample: 980 Avenue de Roumanille

line2stringOptionalExample: Le Fairway, Bâtiment A

citystringOptionalExample: Biot

statestringOptionalExample: France

zipstringOptionalExample: 6410

zipPlusFourstringOptionalExample: 6410

404

Phone number not found

application/json

get/api/v1/customer/phone-number/{phoneNumber}/address

GET /api/v1/customer/phone-number/{phoneNumber}/address HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "property": "Symphony",
  "line1": "980 Avenue de Roumanille",
  "line2": "Le Fairway, Bâtiment A",
  "city": "Biot",
  "state": "France",
  "zip": 6410,
  "zipPlusFour": 6410
}

Update phone number address

Update phone number's address

put

Update phone number's address

Authorizations

AuthorizationstringRequired

HTTP header

Path parameters

phoneNumberstring · phoneRequired

Phone number

Body

propertystringOptionalExample: Symphony

line1stringOptionalExample: 980 Avenue de Roumanille

line2stringOptionalExample: Le Fairway, Bâtiment A

citystringOptionalExample: Biot

statestringOptionalExample: France

zipstringOptionalExample: 6410

zipPlusFourstringOptionalExample: 6410

Responses

204

The phone number's address has been successfully updated

application/json

propertystringOptionalExample: Symphony

line1stringOptionalExample: 980 Avenue de Roumanille

line2stringOptionalExample: Le Fairway, Bâtiment A

citystringOptionalExample: Biot

statestringOptionalExample: France

zipstringOptionalExample: 6410

zipPlusFourstringOptionalExample: 6410

400

Nothing to update

application/json

404

Phone number not found

application/json

put/api/v1/customer/phone-number/{phoneNumber}/address

PUT /api/v1/customer/phone-number/{phoneNumber}/address HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 153

{
  "property": "Symphony",
  "line1": "980 Avenue de Roumanille",
  "line2": "Le Fairway, Bâtiment A",
  "city": "Biot",
  "state": "France",
  "zip": 6410,
  "zipPlusFour": 6410
}

{
  "property": "Symphony",
  "line1": "980 Avenue de Roumanille",
  "line2": "Le Fairway, Bâtiment A",
  "city": "Biot",
  "state": "France",
  "zip": 6410,
  "zipPlusFour": 6410
}

Remove phone number address

Remove phone number's address

delete

Remove phone number's address

Authorizations

AuthorizationstringRequired

HTTP header

Path parameters

phoneNumberstring · phoneRequired

Phone number

Responses

204

The phone number's address has been successfully removed

No content

404

Phone number not found

application/json

delete/api/v1/customer/phone-number/{phoneNumber}/address

DELETE /api/v1/customer/phone-number/{phoneNumber}/address HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Advisor's phone number info

Get Advisor phone number details

get

Get Advisor phone number details.

Authorizations

AuthorizationstringRequired

HTTP header

Path parameters

advisorSymphonyIdstringRequired

Advisor's symphony ID

Pattern: ^\d+$

Responses

200

Request processed

application/json

phoneNumberstringOptionalExample: 911234567890

subNetworkstringOptional

sub network of the phone, either:

SECOND-NUMBER
IN-NETWORK

countrystringOptional

carrierstringOptional

statusstringOptional

Phone number status

USED
FREE
RELEASED
ON_HOLD

productCodeintegerOptional

productstringOptional

For fully ported or partially ported numbers

PRE_ALLOCATED_NUMBER
PRE_ALLOCATED_FULL
SECOND_NUMBER
SECOND_NUMBER_FULL
VOICE (For In-Network numbers only)
SMS (For In-Network numbers only)

providerstring · enumOptionalPossible values:

404

This may happen if:

The advisor does not have any phone number associated.
The requested advisor is not found.

application/json

get/api/v1/customer/advisors/{advisorSymphonyId}/phone-number

GET /api/v1/customer/advisors/{advisorSymphonyId}/phone-number HTTP/1.1
Host: CONNECT-DOMAIN
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "phoneNumber": 911234567890,
  "subNetwork": "text",
  "country": "text",
  "carrier": "text",
  "status": "text",
  "productCode": 1,
  "product": "text",
  "provider": "UMONY",
  "assignedTo": {
    "advisorSymphonyId": 911234567890,
    "advisorFirstName": "text",
    "advisorLastName": "text"
  },
  "externalNetworks": [
    {
      "externalNetwork": "WHATSAPP-DIRECT",
      "availability": "text",
      "empStatus": "CONNECTED"
    }
  ]
}

PreviousPermissions API

NextRoom API

Last updated 1 month ago