Create a cloud phone number type entry for given communication party

Create a cloud phone number type entry for given communication party

application/json

Request Body required

cloudPhoneNumberTypeDTO object
communicatingParties string required
communicatingPartiesDisplayTitle string
defaultVoiceMode string required
defaultVoiceAutoResponseURL string
defaultTextMode string required
defaultTextAutoResponse string required
voiceWebhook string required
voiceMethod string
textWebhook string
textMethod string
capabilities string
featureUUID string
menuOrder int32
voiceAPI string

Responses

• 200

---

OK

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode string
errorDescription string
errorUID string
]
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "errorUID": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

POST /admin/cloudPhoneNumberTypes

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/communications

Username

Password

Body required

{
  "cloudPhoneNumberTypeDTO": {
    "communicatingParties": "string",
    "communicatingPartiesDisplayTitle": "string",
    "defaultVoiceMode": "string",
    "defaultVoiceAutoResponseURL": "string",
    "defaultTextMode": "string",
    "defaultTextAutoResponse": "string",
    "voiceWebhook": "string",
    "voiceMethod": "string",
    "textWebhook": "string",
    "textMethod": "string",
    "capabilities": "string",
    "featureUUID": "string",
    "menuOrder": 0,
    "voiceAPI": "string"
  }
}

curl / cURL

curl -L -X POST '/communications/admin/cloudPhoneNumberTypes' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "cloudPhoneNumberTypeDTO": {
    "communicatingParties": "string",
    "communicatingPartiesDisplayTitle": "string",
    "defaultVoiceMode": "string",
    "defaultVoiceAutoResponseURL": "string",
    "defaultTextMode": "string",
    "defaultTextAutoResponse": "string",
    "voiceWebhook": "string",
    "voiceMethod": "string",
    "textWebhook": "string",
    "textMethod": "string",
    "capabilities": "string",
    "featureUUID": "string",
    "menuOrder": 0,
    "voiceAPI": "string"
  }
}'

python / requests

curl -L -X POST '/communications/admin/cloudPhoneNumberTypes' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "cloudPhoneNumberTypeDTO": {
    "communicatingParties": "string",
    "communicatingPartiesDisplayTitle": "string",
    "defaultVoiceMode": "string",
    "defaultVoiceAutoResponseURL": "string",
    "defaultTextMode": "string",
    "defaultTextAutoResponse": "string",
    "voiceWebhook": "string",
    "voiceMethod": "string",
    "textWebhook": "string",
    "textMethod": "string",
    "capabilities": "string",
    "featureUUID": "string",
    "menuOrder": 0,
    "voiceAPI": "string"
  }
}'

go / native

curl -L -X POST '/communications/admin/cloudPhoneNumberTypes' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "cloudPhoneNumberTypeDTO": {
    "communicatingParties": "string",
    "communicatingPartiesDisplayTitle": "string",
    "defaultVoiceMode": "string",
    "defaultVoiceAutoResponseURL": "string",
    "defaultTextMode": "string",
    "defaultTextAutoResponse": "string",
    "voiceWebhook": "string",
    "voiceMethod": "string",
    "textWebhook": "string",
    "textMethod": "string",
    "capabilities": "string",
    "featureUUID": "string",
    "menuOrder": 0,
    "voiceAPI": "string"
  }
}'

nodejs / axios

curl -L -X POST '/communications/admin/cloudPhoneNumberTypes' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "cloudPhoneNumberTypeDTO": {
    "communicatingParties": "string",
    "communicatingPartiesDisplayTitle": "string",
    "defaultVoiceMode": "string",
    "defaultVoiceAutoResponseURL": "string",
    "defaultTextMode": "string",
    "defaultTextAutoResponse": "string",
    "voiceWebhook": "string",
    "voiceMethod": "string",
    "textWebhook": "string",
    "textMethod": "string",
    "capabilities": "string",
    "featureUUID": "string",
    "menuOrder": 0,
    "voiceAPI": "string"
  }
}'

ruby / Net::HTTP

curl -L -X POST '/communications/admin/cloudPhoneNumberTypes' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "cloudPhoneNumberTypeDTO": {
    "communicatingParties": "string",
    "communicatingPartiesDisplayTitle": "string",
    "defaultVoiceMode": "string",
    "defaultVoiceAutoResponseURL": "string",
    "defaultTextMode": "string",
    "defaultTextAutoResponse": "string",
    "voiceWebhook": "string",
    "voiceMethod": "string",
    "textWebhook": "string",
    "textMethod": "string",
    "capabilities": "string",
    "featureUUID": "string",
    "menuOrder": 0,
    "voiceAPI": "string"
  }
}'

csharp / RestSharp

curl -L -X POST '/communications/admin/cloudPhoneNumberTypes' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "cloudPhoneNumberTypeDTO": {
    "communicatingParties": "string",
    "communicatingPartiesDisplayTitle": "string",
    "defaultVoiceMode": "string",
    "defaultVoiceAutoResponseURL": "string",
    "defaultTextMode": "string",
    "defaultTextAutoResponse": "string",
    "voiceWebhook": "string",
    "voiceMethod": "string",
    "textWebhook": "string",
    "textMethod": "string",
    "capabilities": "string",
    "featureUUID": "string",
    "menuOrder": 0,
    "voiceAPI": "string"
  }
}'

php / cURL

curl -L -X POST '/communications/admin/cloudPhoneNumberTypes' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "cloudPhoneNumberTypeDTO": {
    "communicatingParties": "string",
    "communicatingPartiesDisplayTitle": "string",
    "defaultVoiceMode": "string",
    "defaultVoiceAutoResponseURL": "string",
    "defaultTextMode": "string",
    "defaultTextAutoResponse": "string",
    "voiceWebhook": "string",
    "voiceMethod": "string",
    "textWebhook": "string",
    "textMethod": "string",
    "capabilities": "string",
    "featureUUID": "string",
    "menuOrder": 0,
    "voiceAPI": "string"
  }
}'

java / OkHttp

curl -L -X POST '/communications/admin/cloudPhoneNumberTypes' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "cloudPhoneNumberTypeDTO": {
    "communicatingParties": "string",
    "communicatingPartiesDisplayTitle": "string",
    "defaultVoiceMode": "string",
    "defaultVoiceAutoResponseURL": "string",
    "defaultTextMode": "string",
    "defaultTextAutoResponse": "string",
    "voiceWebhook": "string",
    "voiceMethod": "string",
    "textWebhook": "string",
    "textMethod": "string",
    "capabilities": "string",
    "featureUUID": "string",
    "menuOrder": 0,
    "voiceAPI": "string"
  }
}'

powershell / RestMethod

curl -L -X POST '/communications/admin/cloudPhoneNumberTypes' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "cloudPhoneNumberTypeDTO": {
    "communicatingParties": "string",
    "communicatingPartiesDisplayTitle": "string",
    "defaultVoiceMode": "string",
    "defaultVoiceAutoResponseURL": "string",
    "defaultTextMode": "string",
    "defaultTextAutoResponse": "string",
    "voiceWebhook": "string",
    "voiceMethod": "string",
    "textWebhook": "string",
    "textMethod": "string",
    "capabilities": "string",
    "featureUUID": "string",
    "menuOrder": 0,
    "voiceAPI": "string"
  }
}'