Skip to main content

Methods

List filtered verification codes
TypeScript
GET /v1/projects/{id}/platforms/filtered-otpList number area codes
TypeScript
GET /v1/projects/{id}/platforms/sms/numbers/area-codesList number countries
TypeScript
GET /v1/projects/{id}/platforms/sms/numbers/countriesList operations
TypeScript
GET /v1/projects/{id}/platforms/operationsList project platforms
TypeScript
GET /v1/projects/{id}/platformsList a line’s filtered verification codes
TypeScript
GET /v1/projects/{id}/platforms/resources/{resourceId}/filtered-otpList resources
TypeScript
GET /v1/projects/{id}/platforms/resourcesList Voice profiles
TypeScript
GET /v1/projects/{id}/platforms/voice/profilesList WhatsApp account phone numbers
TypeScript
GET /v1/projects/{id}/platforms/whatsapp-business/account/phone-numbersList WhatsApp shared line assignments
TypeScript
GET /v1/projects/{id}/platforms/whatsapp/assignmentsCount filtered verification codes
TypeScript
GET /v1/projects/{id}/platforms/filtered-otp/countCount a line’s filtered verification codes
TypeScript
GET /v1/projects/{id}/platforms/resources/{resourceId}/filtered-otp/countGet default Voice profile
TypeScript
GET /v1/projects/{id}/platforms/voice/profiles/defaultGet project iMessage platform
TypeScript
GET /v1/projects/{id}/platforms/imessageGet operation
TypeScript
GET /v1/projects/{id}/platforms/operations/{operationId}Get project WhatsApp platform
TypeScript
GET /v1/projects/{id}/platforms/whatsappGet resource
TypeScript
GET /v1/projects/{id}/platforms/resources/{resourceId}Get SMS line campaign assignment
TypeScript
GET /v1/projects/{id}/platforms/sms/lines/{resourceId}/campaignGet Voice line profile assignment
TypeScript
GET /v1/projects/{id}/platforms/voice/lines/{resourceId}/profileGet Voice profile
TypeScript
GET /v1/projects/{id}/platforms/voice/profiles/{profileId}Get WhatsApp Business account
TypeScript
GET /v1/projects/{id}/platforms/whatsapp-business/accountGet WhatsApp Business verification code
TypeScript
GET /v1/projects/{id}/platforms/whatsapp-business/numbers/{resourceId}/verification-codeGet WhatsApp shared line assignment
TypeScript
GET /v1/projects/{id}/platforms/whatsapp/assignments/{assignmentId}Get WhatsApp signup config
TypeScript
GET /v1/projects/{id}/platforms/whatsapp-business/signup-configBatch update Voice line assignments
TypeScript
POST /v1/projects/{id}/platforms/voice/lines/profile-assignments/batchCancel operation
TypeScript
POST /v1/projects/{id}/platforms/operations/{operationId}/cancelConnect email domain
TypeScript
POST /v1/projects/{id}/platforms/email/domainsConnect Telegram bot
TypeScript
POST /v1/projects/{id}/platforms/telegram/botsConnect WhatsApp Business
TypeScript
POST /v1/projects/{id}/platforms/whatsapp-business/numbersCreate Voice profile
TypeScript
POST /v1/projects/{id}/platforms/voice/profilesCreate WhatsApp shared line assignment
TypeScript
POST /v1/projects/{id}/platforms/whatsapp/assignmentsCreate WhatsApp VoIP sender
TypeScript
POST /v1/projects/{id}/platforms/whatsapp-business/account/sendersProvision dedicated iMessage line
TypeScript
POST /v1/projects/{id}/platforms/imessage/dedicatedProvision dedicated WhatsApp line
TypeScript
POST /v1/projects/{id}/platforms/whatsapp/dedicatedPurchase SMS number
TypeScript
POST /v1/projects/{id}/platforms/sms/numbersRotate Voice outbound credential
TypeScript
POST /v1/projects/{id}/platforms/voice/profiles/{profileId}/outbound/rotateAssign or replace SMS line campaign
TypeScript
PUT /v1/projects/{id}/platforms/sms/lines/{resourceId}/campaignAssign Voice line profile
TypeScript
PUT /v1/projects/{id}/platforms/voice/lines/{resourceId}/profileConfigure Voice outbound credential
TypeScript
PUT /v1/projects/{id}/platforms/voice/profiles/{profileId}/outboundCreate default Voice profile
TypeScript
PUT /v1/projects/{id}/platforms/voice/profiles/defaultReplace Voice inbound configuration
TypeScript
PUT /v1/projects/{id}/platforms/voice/profiles/{profileId}/inboundUpdate default Voice profile
TypeScript
PATCH /v1/projects/{id}/platforms/voice/profiles/defaultUpdate Voice profile
TypeScript
PATCH /v1/projects/{id}/platforms/voice/profiles/{profileId}Update Voice inbound configuration
TypeScript
PATCH /v1/projects/{id}/platforms/voice/profiles/{profileId}/inboundUpdate Voice outbound authentication
TypeScript
PATCH /v1/projects/{id}/platforms/voice/profiles/{profileId}/outboundDelete Voice profile
TypeScript
DELETE /v1/projects/{id}/platforms/voice/profiles/{profileId}Delete Voice inbound configuration
TypeScript
DELETE /v1/projects/{id}/platforms/voice/profiles/{profileId}/inboundRevoke Voice outbound credential
TypeScript
DELETE /v1/projects/{id}/platforms/voice/profiles/{profileId}/outboundDisconnect WhatsApp Business account
TypeScript
DELETE /v1/projects/{id}/platforms/whatsapp-business/accountRelease dedicated iMessage line
TypeScript
DELETE /v1/projects/{id}/platforms/imessage/dedicated/{resourceId}Release resource
TypeScript
DELETE /v1/projects/{id}/platforms/resources/{resourceId}Release dedicated WhatsApp line
TypeScript
DELETE /v1/projects/{id}/platforms/whatsapp/dedicated/{resourceId}Release WhatsApp shared line assignment
TypeScript
DELETE /v1/projects/{id}/platforms/whatsapp/assignments/{assignmentId}Unassign SMS line campaign
TypeScript
DELETE /v1/projects/{id}/platforms/sms/lines/{resourceId}/campaignUnassign Voice line profile
TypeScript
DELETE /v1/projects/{id}/platforms/voice/lines/{resourceId}/profile

Resources

Models

FilteredVerificationCodePage

array of FilteredVerificationCode
required
string

ListNumberAreaCodesResponse

array of string
required
"US"
required

ListNumberCountriesResponse

array of NumberCountry
required

OperationPage

string
array of Operation
required

ListProjectPlatformsResponse

array of SupportedPlatform
required

ResourcePage

string
array of Resource
required

VoiceProfilePage

string
array of VoiceProfile
required

ListWhatsappAccountPhoneNumbersResponse

array of WhatsappAccountPhoneNumber
required
string
required

SharedLineAssignmentPage

array of SharedLineAssignment
required
string

FilteredVerificationCodeCount

integer
required
string (date-time)
required
string (date-time)
required

VoiceProfile

VoiceProfileConfiguration
required
string (date-time)
required
boolean
required
integer
required
VoiceProfileMediaEncryption
required
string
required
string
required
string
required
"sip"
required
string (date-time)
required
integer
required

ProjectPlatformSettings

One of: SharedProjectPlatformSettings
boolean
required
integer
required
"shared"
required
One of: DedicatedProjectPlatformSettings
boolean
required
"dedicated"
required

GetOperationResponse

Operation
required
Resource

Resource

array of string
required
string (date-time)
required
object
required
string
required
string
required
string (date-time)
ResourceState
required
string
required
string (date-time)
required

GetSmsLineCampaignAssignmentResponse

SmsLineCampaign | null
required
SmsLineCampaignEligibility
required
string | null
required
string
required
integer
required

VoiceLineProfileAssignment

string
integer
string
required
string
required
integer
required
string (date-time)
required

WhatsappBusinessAccount

string | null
required
array of WhatsappBusinessAccountAlert
required
string
required
string | null
required
string (date-time)
required
integer
WhatsappOutboundCapacity
required
WhatsappBusinessAccountRestriction | null
required
WhatsappReviewStatus
required
integer
required
string (date-time)
string
required

GetWhatsappBusinessVerificationCodeResponse

string
required
string (date-time)
required

SharedLineAssignment

string
required
string
required
string (date-time)
required
string
string
string
required
string
SharedLineAssignmentPlatform
required
string
required
string (date-time)
string (date-time)
required

GetWhatsappSignupConfigResponse

string
required
string
required
array of string
required

BatchUpdateVoiceLineProfileAssignmentsResponse

array of VoiceLineProfileAssignment
required

Operation

boolean
required
string (date-time)
required
object
string (date-time)
OperationError
string
required
string
required
OperationReason
string
string
required
string (date-time)
OperationState
required
OperationType
required
string (date-time)
required

RotateVoiceProfileOutboundCredentialResponse

string | null
required
string (date-time) | null
required
integer
required

ConfigureVoiceProfileOutboundResponse

SipOutboundConfiguration
required
string | null
required
integer
required

VoiceProfileInboundConfiguration

SipInboundConfiguration | null
required
integer
required

UpdateVoiceProfileOutboundAuthenticationResponse

SipOutboundConfiguration
required
integer
required

DeleteVoiceProfileOutboundResponse

null
required
integer
required