api.md

Shared

Types:

• ChatHandle
• LinkPartResponse
• MediaPartResponse
• Reaction
• ReactionType
• ServiceType
• TextDecoration
• TextPartResponse

Chats

Types:

• Chat
• LinkPart
• MediaPart
• MessageContent
• TextPart
• ChatCreateResponse
• ChatUpdateResponse
• ChatLeaveChatResponse
• ChatSendVoicememoResponse

Methods:

• client.chats.create({ ...params }) -> ChatCreateResponse
• client.chats.retrieve(chatID) -> Chat
• client.chats.update(chatID, { ...params }) -> ChatUpdateResponse
• client.chats.leaveChat(chatID) -> ChatLeaveChatResponse
• client.chats.listChats({ ...params }) -> ChatsListChatsPagination
• client.chats.markAsRead(chatID) -> void
• client.chats.sendVoicememo(chatID, { ...params }) -> ChatSendVoicememoResponse
• client.chats.shareContactCard(chatID) -> void

Participants

Types:

• ParticipantAddResponse
• ParticipantRemoveResponse

Methods:

• client.chats.participants.add(chatID, { ...params }) -> ParticipantAddResponse
• client.chats.participants.remove(chatID, { ...params }) -> ParticipantRemoveResponse

Typing

Methods:

• client.chats.typing.start(chatID) -> void
• client.chats.typing.stop(chatID) -> void

Messages

Types:

• SentMessage
• MessageSendResponse

Methods:

• client.chats.messages.list(chatID, { ...params }) -> MessagesListMessagesPagination
• client.chats.messages.send(chatID, { ...params }) -> MessageSendResponse

Location

Types:

• GetChatLocationResponse
• LocationRequestResponse

Methods:

• client.chats.location.retrieve(chatID) -> GetChatLocationResponse
• client.chats.location.request(chatID) -> LocationRequestResponse

Polls

Types:

• Poll
• PollEnvelope

Methods:

• client.chats.polls.create(chatID, { ...params }) -> PollEnvelope

Messages

Types:

• Message
• MessageEffect
• ReplyTo
• MessageCreateResponse
• MessageAddReactionResponse
• MessageUpdateAppCardResponse

Methods:

• client.messages.create({ ...params }) -> MessageCreateResponse
• client.messages.retrieve(messageID) -> Message
• client.messages.update(messageID, { ...params }) -> Message
• client.messages.delete(messageID) -> void
• client.messages.addReaction(messageID, { ...params }) -> MessageAddReactionResponse
• client.messages.listMessagesThread(messageID, { ...params }) -> MessagesListMessagesPagination
• client.messages.updateAppCard(messageID, { ...params }) -> MessageUpdateAppCardResponse

Poll

Methods:

• client.messages.poll.retrieve(messageID) -> PollEnvelope
• client.messages.poll.addOptions(messageID, { ...params }) -> PollEnvelope
• client.messages.poll.vote(messageID, { ...params }) -> PollEnvelope

Attachments

Types:

• SupportedContentType
• AttachmentCreateResponse
• AttachmentRetrieveResponse

Methods:

• client.attachments.create({ ...params }) -> AttachmentCreateResponse
• client.attachments.retrieve(attachmentID) -> AttachmentRetrieveResponse
• client.attachments.delete(attachmentID) -> void

Phonenumbers

Types:

• PhonenumberListResponse

Methods:

• client.phonenumbers.list() -> PhonenumberListResponse

PhoneNumbers

Types:

• PhoneNumberUpdateResponse
• PhoneNumberListResponse

Methods:

• client.phoneNumbers.update(phoneNumberID, { ...params }) -> PhoneNumberUpdateResponse
• client.phoneNumbers.list() -> PhoneNumberListResponse

AvailableNumber

Types:

• AvailableNumberRetrieveResponse

Methods:

• client.availableNumber.retrieve({ ...params }) -> AvailableNumberRetrieveResponse

PaymentRequests

Types:

• PaymentRequest
• PaymentRequestListResponse

Methods:

• client.paymentRequests.create({ ...params }) -> PaymentRequest
• client.paymentRequests.retrieve(paymentRequestID) -> PaymentRequest
• client.paymentRequests.list({ ...params }) -> PaymentRequestListResponse
• client.paymentRequests.cancel(paymentRequestID) -> PaymentRequest

PaymentProviders

Types:

• PaymentProvider
• PaymentProviderConnectResponse

Methods:

• client.paymentProviders.retrieve(provider) -> PaymentProvider
• client.paymentProviders.connect(provider, { ...params }) -> PaymentProviderConnectResponse

PaymentHandles

Types:

• PaymentHandleConnection

Methods:

• client.paymentHandles.connect(handle) -> PaymentHandleConnection
• client.paymentHandles.connection(handle) -> PaymentHandleConnection
• client.paymentHandles.revoke(handle) -> PaymentHandleConnection
• client.paymentHandles.verify(handle, { ...params }) -> PaymentHandleConnection

Payments

Types:

• Payment
• PaymentCredentialsResponse

Methods:

• client.payments.create({ ...params }) -> Payment
• client.payments.retrieve(paymentID) -> Payment
• client.payments.cancel(paymentID) -> Payment
• client.payments.credentials(paymentID) -> PaymentCredentialsResponse

Experiences

Types:

• ExperienceRetrieveResponse
• ExperienceListResponse

Methods:

• client.experiences.retrieve(experience) -> ExperienceRetrieveResponse
• client.experiences.list() -> ExperienceListResponse

WebhookEvents

Types:

• WebhookEventType
• WebhookEventListResponse

Methods:

• client.webhookEvents.list() -> WebhookEventListResponse

WebhookSubscriptions

Types:

• WebhookSubscription
• WebhookSubscriptionCreateResponse
• WebhookSubscriptionListResponse

Methods:

• client.webhookSubscriptions.create({ ...params }) -> WebhookSubscriptionCreateResponse
• client.webhookSubscriptions.retrieve(subscriptionID) -> WebhookSubscription
• client.webhookSubscriptions.update(subscriptionID, { ...params }) -> WebhookSubscription
• client.webhookSubscriptions.list() -> WebhookSubscriptionListResponse
• client.webhookSubscriptions.delete(subscriptionID) -> void

Capability

Types:

• HandleCheck
• HandleCheckResponse

Methods:

• client.capability.checkIMessage({ ...params }) -> HandleCheckResponse
• client.capability.checkRCS({ ...params }) -> HandleCheckResponse

Webhooks

Types:

• MessageEventV2
• MessagePayload
• ReactionEventBase
• SchemasMediaPartResponse
• SchemasMessageEffect
• SchemasTextPartResponse
• MessageSentWebhookEvent
• MessageReceivedWebhookEvent
• MessageReadWebhookEvent
• MessageDeliveredWebhookEvent
• MessageFailedWebhookEvent
• MessageEditedWebhookEvent
• ReactionAddedWebhookEvent
• ReactionRemovedWebhookEvent
• ParticipantAddedWebhookEvent
• ParticipantRemovedWebhookEvent
• ChatCreatedWebhookEvent
• ChatGroupNameUpdatedWebhookEvent
• ChatGroupIconUpdatedWebhookEvent
• ChatGroupNameUpdateFailedWebhookEvent
• ChatGroupIconUpdateFailedWebhookEvent
• ChatTypingIndicatorStartedWebhookEvent
• ChatTypingIndicatorStoppedWebhookEvent
• PhoneNumberStatusUpdatedWebhookEvent
• UnwrapWebhookEvent

Methods:

• client.webhooks.unwrap(body) -> void

ContactCard

Types:

• SetContactCard
• ContactCardRetrieveResponse

Methods:

• client.contactCard.create({ ...params }) -> SetContactCard
• client.contactCard.retrieve({ ...params }) -> ContactCardRetrieveResponse
• client.contactCard.update({ ...params }) -> SetContactCard