Get your Org Channel API ID

If you're using our API to send text messages, you'll often need to specify the outbound phone number's identifier.

In the UI, you can obtain the API ID by simply visiting Admin -> Channels -> Click on the Kebab Menu of your desired phone number, and click Info.
This opens up a side-pane, where you can view the API ID.

You can also obtain this ID via the API itself by making a GET request on our /org_channels endpoint:

curl -X 'GET' \
  'https://${subdomain}.prompt.io/rest/1.0/org_channels?first=0&max=200' \
  -H 'accept: application/json' \
  -H 'orgAuthToken: ${apiKey}'

In the response payload, you'll find a list of your channels containing both the apiId (string), and the numeric id (int).

{
  "orgChannels": [
    {
      "id": 2,
      "name": "+1 (555) 123-4567 (fake phone number)",
      "apiId": "ps_1_555_1234567",
      "channelType": "MANAGED_SIGNAL_WIRE",
      "registrationStatus": "REGISTERED",
      "active": true,
      "channelKey": "+15551234567",
      "firstMessage": "",
      "firstMessageEnabled": false,
      "apiOptOutMessage": "",
      "apiOptOutMessageEnabled": false,
      "optOutFinalMessage": null,
      "optOutFinalMessageEnabled": false,
      "incomingCallResponseType": "PLAY_AUDIO",
      "incomingCallAudioUploadId": 937,
      "prePurchased": false,
      "channelApps": [
        "428"
      ]
    },
    ...
  ]
}