Phone number API

circle-exclamation

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
chevron-right
200

Found phone number provided by Symphony

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

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
chevron-right
200

The phone number was successfully updated.

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

Get phone number details

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
chevron-right
200

Request processed

application/json
get
/api/v1/customer/phone-numbers
200

Request processed

Get phone number address

Get phone address

get

Get phone address

Authorizations
AuthorizationstringRequired

HTTP header

Path parameters
phoneNumberstring · phoneRequired

Phone number

Responses
chevron-right
200

Found phone address

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

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
put
/api/v1/customer/phone-number/{phoneNumber}/address

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
delete
/api/v1/customer/phone-number/{phoneNumber}/address

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
chevron-right
200

Request processed

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

Last updated