Chilkat Online Tools

lianja / Plivo REST API / Add a number from your own carrier

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loHttp = createobject("CkHttp")

loHttp.BasicAuth = .T.
loHttp.Login = "{{auth_id}}"
loHttp.Password = "password"

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "numbers": "18554675486",
//   "carrier": "13455781930894",
//   "region": "California",
//   "number_type": "local",
//   "app_id": "77494029089751836",
//   "subaccount": "SAXXXXXXXXXXXXX"
// }

loJson = createobject("CkJsonObject")
loJson.UpdateString("numbers","18554675486")
loJson.UpdateString("carrier","13455781930894")
loJson.UpdateString("region","California")
loJson.UpdateString("number_type","local")
loJson.UpdateString("app_id","77494029089751836")
loJson.UpdateString("subaccount","SAXXXXXXXXXXXXX")

loResp = loHttp.PostJson3("https://api.plivo.com/v1/Account/<auth_id>/Number/","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    return
endif

? str(loResp.StatusCode)
? loResp.BodyStr
release loResp


release loHttp
release loJson

Curl Command

curl -X POST
	-u '{{auth_id}}:password'
	-d '{
    "numbers": "18554675486",
    "carrier": "13455781930894",
    "region": "California",
    "number_type": "local",
    "app_id": "77494029089751836",
    "subaccount": "SAXXXXXXXXXXXXX"
}'
https://api.plivo.com/v1/Account/<auth_id>/Number/

Postman Collection Item JSON

{
  "name": "Add a number from your own carrier",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"numbers\": \"18554675486\",\n    \"carrier\": \"13455781930894\",\n    \"region\": \"California\",\n    \"number_type\": \"local\",\n    \"app_id\": \"77494029089751836\",\n    \"subaccount\": \"SAXXXXXXXXXXXXX\"\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Number/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Number",
        ""
      ]
    },
    "description": "Adds a phone number from your own carrier, to your account.\n\nBelow is the list of arguments that can be passed in this API request, more information can be found [here](https://www.plivo.com/docs/numbers/api/account-phone-number#add-number-from-my-carrier)\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n| numbers      | A comma separated list of numbers to be added to the account. These numbers should be configured to point to the <phone_number\\>@sbc.plivo.com SIP address. For instance, the phone number 18554675486 needs to point to the 18554675486@sbc.plivo.com SIP address.| Required  |\n| carrier      | The ID of the IncomingCarrier that the number is associated with. For more information, check [IncomingCarrier](https://www.plivo.com/docs/numbers/api/incoming-carrier/).| Required  |\n| region      | The region of this phone number. You can use it to identify phone numbers based on the region.| Required  |\n| number_type      | The type of the phone number. You can use it differentiate between different types of phone numbers in the account. You may use this field to categorize between mobile, local and tollfree numbers. Default is local.| Optional  |\n| app_id      | The application to be assigned to the phone number. If not specified, the application selected as the default_number_app of the Account is assigned. For more information, refer default_number_app argument in [application](https://www.plivo.com/docs/account/api/application#create-an-application) and app_id attribute in [application object](https://www.plivo.com/docs/account/api/application#create-an-application).| Optional  |\n| subaccount      | TThe auth_id of the subaccount to which this number should be added. This can be performed only by the main account.| Optional  |"
  },
  "response": [
  ]
}