TRtryhamsa

Assign a phone number to a Voice Agent.

post/v1/voice-agents/assign-number

Request

  • Base URL
    https://api.tryhamsa.com
  • URL
    https://api.tryhamsa.com/v1/voice-agents/assign-number
  • Auth
    API key in header Authorization

Request body

voiceAgentIdstring required

UUID of the voice agent to assign phone number to.

phoneNumberstring

Phone number to assign to voice agent, should start with + and the country code.

Example request

{
  "voiceAgentId": "d949f13f-40d2-4e48-ac86-b66633070603",
  "phoneNumber": "+9700000000"
}

Response

Successful response

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Success",
  "data": {
    "id": "d949f13f-40d2-4e48-ac86-b66633070603",
    "number": "+9700000000",
    "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"
    },
    "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"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.