Skip to main content

Provision a cloud phone number for given dealer and communication parties​

Provision a cloud phone number for given dealer and communication parties

Path Parameters
    dealerUUID string required
Request Body required
    cloudPhoneNumberDTO object
    dealerUUID string
    communicationCredentialsUsername string
    brokerNumber string
    communicatingParties string
    voiceMode string
    voiceAutoResponseURL string
    textMode string
    textAutoResponse string
    useForOutgoingCommunication boolean
    useForStickiness boolean
    blacklistedOn date-time
    uuid string
Responses

OK

Schema
    errors object[]
  • Array [
    • errorCode string
    errorDescription string
    errorUID string
  • ]
    • warnings object[]
  • Array [
    • warningCode string
    warningDescription string
  • ]
POST /admin/dealers/:dealerUUID/cloudPhoneNumbers

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL
/communications
Username
Password
dealerUUID — path required
Body required
{

  "cloudPhoneNumberDTO": {

    "dealerUUID": "string",

    "communicationCredentialsUsername": "string",

    "brokerNumber": "string",

    "communicatingParties": "string",

    "voiceMode": "string",

    "voiceAutoResponseURL": "string",

    "textMode": "string",

    "textAutoResponse": "string",

    "useForOutgoingCommunication": true,

    "useForStickiness": true,

    "blacklistedOn": "2025-03-28T11:34:43.234Z",

    "uuid": "string"

  }

}
curl / cURL
curl -L -X POST '/communications/admin/dealers/:dealerUUID/cloudPhoneNumbers' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "cloudPhoneNumberDTO": {
    "dealerUUID": "string",
    "communicationCredentialsUsername": "string",
    "brokerNumber": "string",
    "communicatingParties": "string",
    "voiceMode": "string",
    "voiceAutoResponseURL": "string",
    "textMode": "string",
    "textAutoResponse": "string",
    "useForOutgoingCommunication": true,
    "useForStickiness": true,
    "blacklistedOn": "2025-03-28T11:34:43.234Z",
    "uuid": "string"
  }
}'