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 info

Get information on a phone number provided by Symphony

Get information on a phone number provided by Symphony

GEThttps://CONNECT-DOMAIN/api/v1/customer/phone-number/{phoneNumber}

Authorization

sfsAuthentication

Path parameters

phoneNumber*string (phone)

Phone number provided by Symphony

Response

200404

Found phone number provided by Symphony

Body

application/json

phoneNumber*string

subNetworkstring

countrystring

carrierstring

providerstring

statusstring

addressaddress-response (object)

Request

JavaScriptCurl

const response = await fetch('https://CONNECT-DOMAIN/api/v1/customer/phone-number/{phoneNumber}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

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

Get phone number address

Get phone address

Get phone address

GEThttps://CONNECT-DOMAIN/api/v1/customer/phone-number/{phoneNumber}/address

Authorization

sfsAuthentication

Path parameters

phoneNumber*string (phone)

Phone number

Response

200404

Found phone address

Body

application/json

propertystring

line1string

line2string

citystring

statestring

zipstring

zipPlusFourstring

Request

JavaScriptCurl

const response = await fetch('https://CONNECT-DOMAIN/api/v1/customer/phone-number/{phoneNumber}/address', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

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

Update phone number's address

PUThttps://CONNECT-DOMAIN/api/v1/customer/phone-number/{phoneNumber}/address

Authorization

sfsAuthentication

Path parameters

phoneNumber*string (phone)

Phone number

Body

application/json

propertystring

line1string

line2string

citystring

statestring

zipstring

zipPlusFourstring

Response

204400404

The phone number's address has been successfully updated

Body

application/json

propertystring

line1string

line2string

citystring

statestring

zipstring

zipPlusFourstring

Request

JavaScriptCurl

const response = await fetch('https://CONNECT-DOMAIN/api/v1/customer/phone-number/{phoneNumber}/address', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Remove phone number's address

DELETEhttps://CONNECT-DOMAIN/api/v1/customer/phone-number/{phoneNumber}/address

Authorization

sfsAuthentication

Path parameters

phoneNumber*string (phone)

Phone number

Response

204404

The phone number's address has been successfully removed

Request

JavaScriptCurl

const response = await fetch('https://CONNECT-DOMAIN/api/v1/customer/phone-number/{phoneNumber}/address', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();