Skip to navigation
Atlas APIPhone Numbers

Integrate new phone number

Integrates a phone number from an external provider into a campaign.

Provider-specific fields:

  • twilio: requires twilioAccountSid and twilioAuthToken
  • siptrunk: requires gateways (array of {ip} objects)
  • telnyx: requires telnyxApiKey and telnyxPublicKey (BYO Telnyx numbers only)

Authentication

api-keystring

Your Atlas API key. Get it from the Atlas Portal under Settings > API Keys.

Request

This endpoint expects an object.
campaignIdstringRequired
providerenumRequired
Allowed values:
numberstringRequired
Phone number in E.164 format
twilioAccountSidstringOptional

Required when provider is twilio

twilioAuthTokenstringOptional

Required when provider is twilio

internalNumberbooleanOptional
telnyxApiKeystringOptional

Required when provider is telnyx. Your Telnyx API key.

telnyxPublicKeystringOptional

Required when provider is telnyx. Your Telnyx account public key (Account Settings > Keys & Credentials > Public Key).

Response

Phone number integrated

Errors

400
Bad Request Error
500
Internal Server Error