Add Phone Number to a User Route

POST /v1/voice-agents/phone-number

Add a phone number for a user.

cURL

curl --request POST \
  --url https://api.tryhamsa.com/v1/voice-agents/phone-number \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumber": "<string>",
  "label": "<string>",
  "twilioAccountSid": "<string>",
  "twilioAuthToken": "<string>"
}
'

200

{
  "success": true,
  "message": "Success",
  "data": {
    "id": "d949f13f-40d2-4e48-ac86-b66633070603",
    "number": "[phone]",
    "label": "My Twilio Number",
    "type": "TWILIO",
    "userId": "d949f13f-40d2-4e48-ac86-b66633070603",
    "sipInboundConfigs": {
      "originationUri": "sip:sip.eu.tryhamsa.com:5060;transport=tcp"
    },
    "sipOutboundConfigs": {
      "address": "sip.example.com",
      "transportType": "TCP",
      "customHeaders": {}
    },
    "voiceAgentId": "d949f13f-40d2-4e48-ac86-b66633070603",
    "voiceAgent": {
      "id": "d949f13f-40d2-4e48-ac86-b66633070603",
      "name": "My Voice Agent"
    },
    "createdAt": "2023-01-01T12:00:00Z",
    "updatedAt": "2023-02-01T12:00:00Z"
  }
}

Authorizations

Authorization · string · header · required

Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '

Body

application/json

Option 1

Option 2

type · enum<string> · required

The type of phone number to add, TWILIO in this case.

Available options: TWILIO

phoneNumber · string · required

The phone number to add to the Twilio numbers of a user.

Minimum string length: 1

label · string · required

A label to identify the phone number.

Minimum string length: 1

twilioAccountSid · string · required

The Twilio Account SID associated with the Twilio number.

Minimum string length: 1

twilioAuthToken · string · required

The Twilio Auth Token for authenticating API requests.

Minimum string length: 1

Response

200

application/json

Successful response

success · boolean

Example:

true

message · string

Example:

"Success"

data · object

Show child attributes