api.md

Webhooks

Types:

• APIMeta
• APIResponseWebhook
• CallEvent
• CallEventPayload
• ChannelEvent
• ChannelEventPayload
• ContactEvent
• ContactEventPayload
• ErrorDetail
• InboundMessageEvent
• InboundMessageEventPayload
• MessageEvent
• MessageEventPayload
• MutationRequest
• PaginationMeta
• TemplateEvent
• TemplateEventPayload
• WebhookEventType
• WebhookResponse
• WebhookListEventTypesResponse
• WebhookListEventsResponse
• WebhookRotateSecretResponse
• WebhookTestResponse

Methods:

• client.webhooks.create({ ...params }) -> APIResponseWebhook
• client.webhooks.retrieve(id, { ...params }) -> APIResponseWebhook
• client.webhooks.update(id, { ...params }) -> APIResponseWebhook
• client.webhooks.list({ ...params }) -> WebhookResponsesWebhooksPage
• client.webhooks.delete(id, { ...params }) -> void
• client.webhooks.listEventTypes({ ...params }) -> WebhookListEventTypesResponse
• client.webhooks.listEvents(id, { ...params }) -> WebhookListEventsResponsesWebhookEventsPage
• client.webhooks.rotateSecret(id, { ...params }) -> WebhookRotateSecretResponse
• client.webhooks.test(id, { ...params }) -> WebhookTestResponse
• client.webhooks.toggleStatus(id, { ...params }) -> APIResponseWebhook

Users

Types:

• APIResponseOfUser
• UserResponse
• UserListResponse

Methods:

• client.users.retrieve(userID, { ...params }) -> APIResponseOfUser
• client.users.list({ ...params }) -> UserListResponse
• client.users.invite({ ...params }) -> APIResponseOfUser
• client.users.remove(userID, { ...params }) -> void
• client.users.updateRole(userID, { ...params }) -> APIResponseOfUser

Templates

Types:

• APIResponseTemplate
• AuthenticationConfig
• Template
• TemplateBody
• TemplateBodyContent
• TemplateButton
• TemplateButtonProps
• TemplateDefinition
• TemplateFooter
• TemplateHeader
• TemplateVariable

Methods:

• client.templates.create({ ...params }) -> APIResponseTemplate
• client.templates.retrieve(id, { ...params }) -> APIResponseTemplate
• client.templates.update(id, { ...params }) -> APIResponseTemplate
• client.templates.list({ ...params }) -> TemplatesTemplatesPage
• client.templates.delete(id, { ...params }) -> void

Profiles

Types:

• APIResponseOfProfileDetail
• BillingContactInfo
• BrandBusinessInfo
• BrandComplianceInfo
• BrandContactInfo
• BrandsBrandData
• DestinationCountry
• PaymentDetails
• ProfileDetail
• TcrBrandRelationship
• TcrVertical
• ProfileListResponse
• ProfileCompleteResponse

Methods:

• client.profiles.create({ ...params }) -> APIResponseOfProfileDetail
• client.profiles.retrieve(profileID, { ...params }) -> APIResponseOfProfileDetail
• client.profiles.update(profileID, { ...params }) -> APIResponseOfProfileDetail
• client.profiles.list({ ...params }) -> ProfileListResponse
• client.profiles.delete(profileID, { ...params }) -> void
• client.profiles.complete(profileID, { ...params }) -> ProfileCompleteResponse

Campaigns

Types:

• APIResponseOfBrandCampaign
• APIResponseOfListOfBrandCampaign
• BrandCampaign
• CampaignData
• CampaignUseCase
• CampaignUseCaseData
• MessagingUseCaseUs

Methods:

• client.profiles.campaigns.create(profileID, { ...params }) -> APIResponseOfBrandCampaign
• client.profiles.campaigns.update(campaignID, { ...params }) -> APIResponseOfBrandCampaign
• client.profiles.campaigns.list(profileID, { ...params }) -> APIResponseOfListOfBrandCampaign
• client.profiles.campaigns.delete(campaignID, { ...params }) -> void

Numbers

Types:

• NumberLookupResponse

Methods:

• client.numbers.lookup(phoneNumber, { ...params }) -> NumberLookupResponse

Messages

Types:

• MessageRetrieveActivitiesResponse
• MessageRetrieveStatusResponse
• MessageSendResponse

Methods:

• client.messages.retrieveActivities(id, { ...params }) -> MessageRetrieveActivitiesResponse
• client.messages.retrieveStatus(id, { ...params }) -> MessageRetrieveStatusResponse
• client.messages.send({ ...params }) -> MessageSendResponse

Contacts

Types:

• APIResponseOfContact
• APIResponseOfContactMessageSummary
• ContactMessageSummary
• ContactResponse

Methods:

• client.contacts.create({ ...params }) -> APIResponseOfContact
• client.contacts.retrieve(id, { ...params }) -> APIResponseOfContact
• client.contacts.update(id, { ...params }) -> APIResponseOfContact
• client.contacts.list({ ...params }) -> ContactResponsesContactsPage
• client.contacts.delete(id, { ...params }) -> void
• client.contacts.retrieveMessageSummary(contactID, { ...params }) -> APIResponseOfContactMessageSummary

Conversations

Types:

• APIResponseOfConversationMessagesList
• ConversationMessagesList

Methods:

• client.conversations.list({ ...params }) -> ConversationMessagesListMessagesConversationsPage
• client.conversations.listMessages(id, { ...params }) -> ConversationMessagesListMessagesConversationsPage

Calls

Types:

• APIResponseOfCall
• APIResponseOfCallRecordings
• APIResponseOfCallsList
• Call
• CallParty
• CallRecording
• CallRecordings
• CallTimelineEntry
• CallsList

Methods:

• client.calls.retrieve(id, { ...params }) -> APIResponseOfCall
• client.calls.list({ ...params }) -> CallsCallsPage
• client.calls.hangup(id, { ...params }) -> void
• client.calls.listRecordings(id, { ...params }) -> APIResponseOfCallRecordings
• client.calls.record(id, { ...params }) -> void

Participants

Types:

• APIResponseOfListOfCallParticipant
• CallParticipant
• CallParticipantTarget

Methods:

• client.calls.participants.update(participantID, { ...params }) -> void
• client.calls.participants.list(id, { ...params }) -> APIResponseOfListOfCallParticipant
• client.calls.participants.add(id, { ...params }) -> APIResponseOfCall
• client.calls.participants.remove(participantID, { ...params }) -> void
• client.calls.participants.removeAll(id, { ...params }) -> void

Channels

Voice

Types:

• APIResponseOfListOfVoiceNumber
• APIResponseOfVoiceCallbackTest
• APIResponseOfVoiceNumber
• APIResponseOfVoiceNumberCreated
• APIResponseOfVoiceSecret
• APIResponseOfVoiceToken
• VoiceCallbackTest
• VoiceCallbackTestErrorInfo
• VoiceCallbackTestRequestInfo
• VoiceCallbackTestResponseInfo
• VoiceNumber
• VoiceNumberCreated
• VoiceSecret
• VoiceToken

Methods:

• client.channels.voice.create({ ...params }) -> APIResponseOfVoiceNumberCreated
• client.channels.voice.retrieve(number, { ...params }) -> APIResponseOfVoiceNumber
• client.channels.voice.update(number, { ...params }) -> APIResponseOfVoiceNumber
• client.channels.voice.list({ ...params }) -> APIResponseOfListOfVoiceNumber
• client.channels.voice.createToken({ ...params }) -> APIResponseOfVoiceToken
• client.channels.voice.rotateSecret(number, { ...params }) -> APIResponseOfVoiceSecret
• client.channels.voice.test(number, { ...params }) -> APIResponseOfVoiceCallbackTest

Me

Types:

• ProfileSettings
• MeRetrieveResponse

Methods:

• client.me.retrieve({ ...params }) -> MeRetrieveResponse