Chilkat Online Tools

SQL Server / Plivo REST API / Add a number from your own carrier

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    EXEC sp_OASetProperty @http, 'BasicAuth', 1
    EXEC sp_OASetProperty @http, 'Login', '{{auth_id}}'
    EXEC sp_OASetProperty @http, '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"
    -- }

    DECLARE @json int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'numbers', '18554675486'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'carrier', '13455781930894'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'region', 'California'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'number_type', 'local'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'app_id', '77494029089751836'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'subaccount', 'SAXXXXXXXXXXXXX'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://api.plivo.com/v1/Account/<auth_id>/Number/', 'application/json', @json
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json


END
GO

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": [
  ]
}