API and SDK reference
Installation
NPM
_10npm add Twilio-Communications-API
Yarn
_10yarn add Twilio-Communications-API
Custom HTTP Client
The TypeScript SDK makes API calls using an HTTPClient that wraps the native
Fetch API. This
client is a thin wrapper around fetch and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The HTTPClient constructor takes an optional fetcher argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to use the "beforeRequest" hook to to add a
custom header and a timeout to requests and how to use the "requestError" hook
to log errors:
_28import { TwillioSDKDocs } from "Twilio-Communications-API";_28import { HTTPClient } from "Twilio-Communications-API/lib/http";_28_28const httpClient = new HTTPClient({_28 // fetcher takes a function that has the same signature as native `fetch`._28 fetcher: (request) => {_28 return fetch(request);_28 }_28});_28_28httpClient.addHook("beforeRequest", (request) => {_28 const nextRequest = new Request(request, {_28 signal: request.signal || AbortSignal.timeout(5000);_28 });_28_28 nextRequest.headers.set("x-custom-header", "custom value");_28_28 return nextRequest;_28});_28_28httpClient.addHook("requestError", (error, request) => {_28 console.group("Request Error");_28 console.log("Reason:", `${error}`);_28 console.log("Endpoint:", `${request.method} ${request.url}`);_28 console.groupEnd();_28});_28_28const sdk = new TwillioSDKDocs({ httpClient });
Security Options
Per-Client Security Schemes
This SDK supports the following security scheme globally:
You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:
_19import { TwillioSDKDocs } from "Twilio-Communications-API";_19_19async function run() {_19 const sdk = new TwillioSDKDocs({_19 security: {_19 username: "<YOUR_USERNAME_HERE>",_19 password: "<YOUR_PASSWORD_HERE>",_19 },_19 });_19_19 const result = await sdk.addressLookups.createAddressLookups({_19 addresses: [,],_19 });_19_19 // Handle the result_19 console.log(result);_19}_19_19run();
Errors
All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
Example
_33import { TwillioSDKDocs } from "Twilio-Communications-API";_33import * as errors from "Twilio-Communications-API/models/errors";_33_33async function run() {_33 const sdk = new TwillioSDKDocs({_33 security: {_33 username: "<YOUR_USERNAME_HERE>",_33 password: "<YOUR_PASSWORD_HERE>",_33 },_33 });_33_33 let result;_33 try {_33 result = await sdk.addressLookups.createAddressLookups({_33 addresses: [,],_33 });_33 } catch (err) {_33 switch (true) {_33 case err instanceof errors.TwilioError: {_33 console.error(err); // handle exception_33 return;_33 }_33 default: {_33 throw err;_33 }_33 }_33 }_33_33 // Handle the result_33 console.log(result);_33}_33_33run();
Server Options
Select Server by Index
You can override the default server globally by passing a server index to the serverIdx optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
_20import { TwillioSDKDocs } from "Twilio-Communications-API";_20_20async function run() {_20 const sdk = new TwillioSDKDocs({_20 serverIdx: 0,_20 security: {_20 username: "<YOUR_USERNAME_HERE>",_20 password: "<YOUR_PASSWORD_HERE>",_20 },_20 });_20_20 const result = await sdk.addressLookups.createAddressLookups({_20 addresses: [,],_20 });_20_20 // Handle the result_20 console.log(result);_20}_20_20run();
Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the serverURL optional parameter when initializing the SDK client instance. For example:
_20import { TwillioSDKDocs } from "Twilio-Communications-API";_20_20async function run() {_20 const sdk = new TwillioSDKDocs({_20 serverURL: "https://comms.twilio.com/preview",_20 security: {_20 username: "<YOUR_USERNAME_HERE>",_20 password: "<YOUR_PASSWORD_HERE>",_20 },_20 });_20_20 const result = await sdk.addressLookups.createAddressLookups({_20 addresses: [,],_20 });_20_20 // Handle the result_20 console.log(result);_20}_20_20run();
Address Lookups
*Use AddressLookups to validate your phone numbers and email addresses and get back a detailed report on their validity and the identity of the people behind them.*
Available Operations
- Create Address Lookups - Lookup Addresses
- List Address Lookups - List AddressLookups
- Fetch One Address Lookup - Fetch an AddressLookup
Address Lookups
Create Address Lookups
This operation creates AddressLookups
Parameters
request: operations.CreateAddressLookupsCreateAddressLookups
The request object to use for the request.
Show child properties
addresses: *operations.AddressLookupInput*[]
A list of communications addresses to fetch additional information for.
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.CreateAddressLookupsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
createAddressLookupsResponse?: operations.CreateAddressLookupsCreateAddressLookupsResponse
Created
Show child properties
headers: Record<string, *string*[]>
Address Lookups
List Address Lookups
This operation fetches a paginated list of AddressLookups.
Parameters
address?: string
Filter AddressLookups by address.
startDate?: Date
Filter to AddressLookups created after the specified date and time.
endDate?: Date
Filter to AddressLookups created before the specified date and time.
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ListAddressLookupsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listAddressLookupsResponse?: operations.ListAddressLookupsListAddressLookupsResponse
OK
Show child properties
headers: Record<string, *string*[]>
Address Lookups
Fetch One Address Lookup
This operation fetches a single AddressLookup using its id.
Parameters
addressLookupId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchOneAddressLookupResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
addressLookup?: components.AddressLookup
OK
headers: Record<string, *string*[]>
Contacts And Audiences
*Use Contacts to build and maintain a reliable directory of customers with validated communications addresses and identity profiles. Build up Audiences and leverage them with Messages, Emails, PushNotifications and Communications to broadcast communications to larger audiences*.
Available Operations
- Create Contacts - Create Contacts
- List Contacts - List Contacts
- Fetch Single Contact - Fetch a Contact
- Update Contact - Update a Contact
- Delete Contact - Delete a Contact
- Update Contacts Settings - Update Contacts Settings
- Fetch Contacts Settings - Fetch Contacts Settings
- Create Preferences - Create Preferences
- List Preferences - List Preferences
- Fetch One Preference - Fetch a Preference
- Update One Preference - Update a Preference
- Delete One Preference - Delete a Preference
- List Contact Preferences - List Contact Preferences
- Fetch One Contact Preference - Fetch a Contact Preference
- Update One Contact Preference - Update a Contact Preference
- Create Audience - Create an Audience
- List Audiences - List Audiences
- Fetch Single Audience - Fetch an Audience
- Delete Audience - Delete an Audience
- Add Contact To Audience - Add Contact to an Audience
- List Contacts In Audience - List Contacts in Audience
- Remove Contact From Audience - Remove Contact from Audience
Contacts & Audiences
Create Contacts
This operation creates Contacts
Parameters
request: operations.CreateContactsCreateContactsRequest
The request object to use for the request.
Show child properties
contacts?: operations.ContactInput[]
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.CreateContactsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
createContactsResponse?: operations.CreateContactsCreateContactsResponse
Created
Show child properties
headers: Record<string, *string*[]>
Contacts & Audiences
List Contacts
This operation fetches a paginated list of Contacts.
Parameters
request: operations.ListContactsRequest
The request object to use for the request.
Show child properties
startDate?: Date
Filter to Contacts created after the specified date and time.
endDate?: Date
Filter to Contacts created before the specified date and time.
updatedDate?: Date
Filter to Contacts updated after the specified date and time.
channel?: components.CommunicationChannel
Filter to Contacts that have at least one address belonging to a specific channel.
Show child properties
firstName?: string
Filter to Contacts that have a specific first_name value.
lastName?: string
Filter to Contacts that have a specific last_name value.
displayName?: string
Filter to Contacts that have a specific display_name value.
userIdentifier?: string
Filter to Contacts that have a specific user_identifier value.
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ListContactsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listContactsResponse?: operations.ListContactsListContactsResponse
OK
Show child properties
headers: Record<string, *string*[]>
Contacts & Audiences
Fetch Single Contact
This operation fetches a single contact using its ID.
Parameters
contactId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchSingleContactResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
contact?: components.Contact
OK
Show child properties
headers: Record<string, *string*[]>
Contacts & Audiences
Update Contact
This operation partially updates a Contact
Parameters
contactId: string
Example: [object Object]
requestBody?: operations.UpdateContactUpdateContactRequest
Show child properties
firstName?: string
lastName?: string
displayName?: string
addresses?: operations.UpdateContactAddress[]
Show child properties
tags?: Record<string, components.Tags>
Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 128 characters. There can be a maximum of 10 key-value pairs.
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.UpdateContactResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
contact?: components.Contact
Ok
Show child properties
headers: Record<string, *string*[]>
Contacts & Audiences
Delete Contact
This operation deletes a Contact
Parameters
contactId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.DeleteContactResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
headers: Record<string, *string*[]>
Contacts & Audiences
Update Contacts Settings
This operation partially updates Contacts Settings
Parameters
request: operations.UpdateContactsSettingsUpdateContactSettings
The request object to use for the request.
Show child properties
autoCreateWith?: operations.AutoCreateWith[]
A list of related resources which, when created, will also automatically create (or update) a Contact when specifying a recipient/end-user.
Show child properties
autoValidateAddresses?: operations.ContactsSettingsAutoValidateAddresses
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.UpdateContactsSettingsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
contactsSettings?: components.ContactsSettings
Ok
Show child properties
headers: Record<string, *string*[]>
Contacts & Audiences
Fetch Contacts Settings
This operation fetches Contacts Settings
Parameters
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchContactsSettingsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
contactsSettings?: components.ContactsSettings
OK
Show child properties
headers: Record<string, *string*[]>
Contacts & Audiences
Create Preferences
This operation creates Preferences
Parameters
request: operations.CreatePreferencesCreatePreferenceRequest
The request object to use for the request.
Show child properties
name: string
The name of the Preference.
description?: string
The description of the Preference.
isPublic?: boolean
Whether the Preference is public or private.
channels: components.PreferenceChannelDefault[]
The channel controls available for the Preference
Show child properties
tags?: Record<string, components.Tags>
Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 128 characters. There can be a maximum of 10 key-value pairs.
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.CreatePreferencesResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
preference?: components.Preference
Created
Show child properties
headers: Record<string, *string*[]>
Contacts & Audiences
List Preferences
This operation fetches a paginated list of Preferences
Parameters
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ListPreferencesResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listPreferencesResponse?: operations.ListPreferencesListPreferencesResponse
OK
Show child properties
headers: Record<string, *string*[]>
Contacts & Audiences
Fetch One Preference
This operation fetches a single Preference using its id.
Parameters
preferenceId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchOnePreferenceResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
preference?: components.Preference
OK
Show child properties
headers: Record<string, *string*[]>
Contacts & Audiences
Update One Preference
This operation updates a single Preference using its id.
Parameters
preferenceId: string
Example: [object Object]
requestBody: operations.UpdateOnePreferenceUpdatePreferenceRequest
Show child properties
name?: string
The name of the Preference.
channels?: components.CommunicationType[]
The channel controls available for the Preference
Show child properties
isPublic?: boolean
Whether the Preference is public or private. Use this to seperate Preferences that should and should not be exposed to your Contacts. Filter Contact Preferences by this field to determine which Contact Preferences to show in your UI.
tags?: Record<string, components.Tags>
Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 128 characters. There can be a maximum of 10 key-value pairs.
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.UpdateOnePreferenceResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
preference?: components.Preference
OK
Show child properties
headers: Record<string, *string*[]>
Contacts & Audiences
Delete One Preference
This operation deletes a single Preference using its id.
Parameters
preferenceId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.DeleteOnePreferenceResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
headers: Record<string, *string*[]>
Contacts & Audiences
List Contact Preferences
This operation fetches a paginated list of Preferences
Parameters
contactId: string
Example: [object Object]
isPublic?: boolean
Filter to public or private Preferences.
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ListContactPreferencesResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listContactPreferencesResponse?: operations.ListContactPreferencesListContactPreferencesResponse
OK
Show child properties
headers: Record<string, *string*[]>
Contacts & Audiences
Fetch One Contact Preference
This operation fetches a single Contact Preference using its id.
Parameters
contactId: string
Example: [object Object]
contactPreferenceId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchOneContactPreferenceResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
contactPreference?: components.ContactPreference
OK
Show child properties
headers: Record<string, *string*[]>
Contacts & Audiences
Update One Contact Preference
This operation updates a single Contact Preference using its id.
Parameters
contactId: string
Example: [object Object]
contactPreferenceId: string
Example: [object Object]
requestBody: operations.UpdateOneContactPreferenceUpdatePreferenceRequest
Show child properties
channels?: components.PreferenceChannel[]
A list of channels and their associated statuses that determine whether a Contact can receive communications on that channel.
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.UpdateOneContactPreferenceResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
contactPreference?: components.ContactPreference
OK
Show child properties
headers: Record<string, *string*[]>
Contacts & Audiences
Create Audience
This operation creates an Audience
Parameters
request: operations.CreateAudienceCreateAudienceRequest
The request object to use for the request.
Show child properties
name?: string
A friendly name for the Audience.
tags?: Record<string, components.Tags>
Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 128 characters. There can be a maximum of 10 key-value pairs.
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.CreateAudienceResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
audience?: components.Audience
Created
Show child properties
headers: Record<string, *string*[]>
Contacts & Audiences
List Audiences
This operation fetches a paginated list of Audiences.
Parameters
startDate?: Date
Filter to Audiences created after the specified date and time.
endDate?: Date
Filter to Audiences created before the specified date and time.
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ListAudiencesResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listAudiencesResponse?: operations.ListAudiencesListAudiencesResponse
OK
Show child properties
headers: Record<string, *string*[]>
Contacts & Audiences
Fetch Single Audience
This operation fetches a single Audience using its Id.
Parameters
audienceId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchSingleAudienceResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
audience?: components.Audience
OK
Show child properties
headers: Record<string, *string*[]>
Contacts & Audiences
Delete Audience
This operation deletes an Audience using its Id.
Parameters
audienceId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.DeleteAudienceResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
headers: Record<string, *string*[]>
Contacts & Audiences
Add Contact To Audience
This operation adds a Contact to an Audience
Parameters
audienceId: string
Example: [object Object]
requestBody?: operations.AddContactToAudienceAddContactToAudienceRequest
Show child properties
contactId?: string
A reference to a Contact.
Example: contact_01h9krwprkeee8fzqspvwy6nq8
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.AddContactToAudienceResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
audience?: components.Audience
Created
Show child properties
headers: Record<string, *string*[]>
Contacts & Audiences
List Contacts In Audience
This operation fetches a paginated list of Contacts that belong to an Audience.
Parameters
audienceId: string
Example: [object Object]
startDate?: Date
Filter to Contacts that were added to the Audience after the specified date and time.
endDate?: Date
Filter to Contacts that were added to the Audience before the specified date and time.
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ListContactsInAudienceResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listContactsInAudienceResponse?: operations.ListContactsInAudienceListContactsInAudienceResponse
OK
Show child properties
headers: Record<string, *string*[]>
Contacts & Audiences
Remove Contact From Audience
This operation removes a Contact from an Audience
Parameters
audienceId: string
Example: [object Object]
contactId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.RemoveContactFromAudienceResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
headers: Record<string, *string*[]>
Emails
*Use Emails to send and receive email with Twilio SendGrid.*
Available Operations
- Send Emails - Send Emails
- List Emails - List Emails
- Fetch One Email - Fetch an Email
- Delete Email - Delete an Email
- List Email Operations - List Email Operations
- Fetch One Email Operation - Fetch an Email Operation
- Cancel Email Operation - Cancel an Email Operation
Emails
Send Emails
This operation creates and sends out emails to the specified recipients.
Parameters
request: operations.SendEmailsSendEmailsRequest
The request object to use for the request.
Show child properties
from: operations.SendEmailsRequestFrom
The sending identity to associate with the email.
to?: *operations.SendEmailsRecipient*[]
A list of recipients to send the email(s) to.
content: operations.SendEmailsRequestContent
The content of the Email.
- Use EmailContentInput to construct the content of your Email.
- Use OTPEmailContentInput to send an Email with an OTP to Verify your recipient.
- Use EmailContentTemplateInput to reference a stored Content template.
replyTo?: *operations.SendEmailsRequestReplyToRecipient*[]
A list of recipients to send replies to when the recipient of this email attempts to reply.
cc?: *operations.SendEmailsRequestCCRecipient*[]
A list of recipients to carbon-copy ('cc') emails to. Recipients will have visibility of eachother's addresses.
bcc?: *operations.SendEmailsRequestBCCRecipient*[]
A list of recipients to blindly carbon-copy ('cc') emails to. Recipients will NOT have visibility of eachother's addresses.
tags?: Record<string, components.Tags>
Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 128 characters. There can be a maximum of 10 key-value pairs.
Show child properties
processingOptions?: operations.SendEmailsRequestProcessingOptions
Additional options to control how the email is processed.
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.SendEmailsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
sendEmailsResponse?: operations.SendEmailsSendEmailsResponse
Created
Show child properties
headers: Record<string, *string*[]>
Emails
List Emails
This operation fetches a paginated list of Emails.
Parameters
request: operations.ListEmailsRequest
The request object to use for the request.
Show child properties
operationId?: string
Filter to Emails created in a specific Operation.
Example: operation_01h9krwprkeee8fzqspvwy6nq8
conversationId?: string
Filter Messages belonging to a conversation.
Example: conversation_01h9krwprkeee8fzqspvwy6nq8
startDate?: Date
Filter Emails created after the specified date and time.
endDate?: Date
Filter Emails created before the specified date and time.
fromAddress?: string
Filter Emails sent from an address.
toAddress?: string
Filter Emails sent to an address.
toContact?: string
Filter Emails sent to a specific Contact.
Example: contact_01h9krwprkeee8fzqspvwy6nq8
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ListEmailsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listEmailsResponse?: operations.ListEmailsListEmailsResponse
OK
Show child properties
headers: Record<string, *string*[]>
Emails
Fetch One Email
This operation fetches a single Email using its id.
Parameters
emailId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchOneEmailResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
email?: components.Email
OK
Show child properties
headers: Record<string, *string*[]>
Emails
Delete Email
This operation deletes an Email
Parameters
emailId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.DeleteEmailResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
headers: Record<string, *string*[]>
Emails
List Email Operations
This operation fetches a paginated list of Email Operations.
Parameters
startDate?: Date
Filter to Operations created after the specified date and time.
endDate?: Date
Filter to Operations created before the specified date and time.
status?: components.EmailOperationStatus
Filter to Operations with the specified status.
Show child properties
| Name | Value |
|---|---|
processing | processing |
completed | completed |
canceled | canceled |
failed | failed |
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ListEmailOperationsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listEmailOperationsResponse?: operations.ListEmailOperationsListEmailOperationsResponse
OK
Show child properties
headers: Record<string, *string*[]>
Emails
Fetch One Email Operation
This operation fetches a single Email Operation using its id.
Parameters
operationId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchOneEmailOperationResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
emailOperation?: components.EmailOperation
OK
Show child properties
headers: Record<string, *string*[]>
Emails
Cancel Email Operation
This operation cancels an Email Operation using its id.
Parameters
operationId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.CancelEmailOperationResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
emailOperation?: components.EmailOperation
OK
Show child properties
headers: Record<string, *string*[]>
Messages
*Use Messages to send and receive SMS & MMS, WhatsApp, Facebook Messenger, and Google Business messages.*
Available Operations
- Send Messages - Send Messages
- List Messages - List Messages
- Fetch One Message - Fetch a Message
- Delete Message - Delete a Message
- List Message Operations - List Message Operations
- Fetch One Message Operation - Fetch a Message Operation
- Cancel Message Operation - Cancel a Message Operation
Messages
Send Messages
This operation creates and sends out messages to the specified recipients.
Parameters
request: operations.SendMessagesSendMessagesRequest
The request object to use for the request.
Show child properties
from: operations.SendMessagesRequestFrom
The sending identity to associate with the Message(s).
to: *operations.SendMessagesRecipient*[]
An array of recipient objects to send the message(s) to.
- Use an AddressRecipient to describe the recipient by their address.
- Use a ContactRecipient to reference a stored Contact.
- Use a RecipientGroup for Group Messaging.
- Use a ConversationRecipient to add a Message to a Conversation.
content: operations.SendMessagesRequestContent
The content of the Message.
- Use MessagesRequestContent to specify simple content for your Message.
- Use MessagesRequestContentRich to construct rich content for your Message
- Use MessagesRequestContentOTP to send a Message with an OTP to Verify your recipient.
- Use MessagesRequestContentTemplate to reference a stored Content template
processingOptions?: operations.SendMessagesRequestProcessingOptions
Directives for how to process and dispatch the Message(s).
Show child properties
tags?: Record<string, components.Tags>
Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 128 characters. There can be a maximum of 10 key-value pairs.
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.SendMessagesResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
sendMessagesResponse?: operations.SendMessagesSendMessagesResponse
Created
Show child properties
headers: Record<string, *string*[]>
Messages
List Messages
This operation fetches a paginated list of Messages.
Parameters
request: operations.ListMessagesRequest
The request object to use for the request.
Show child properties
operationId?: string
Filter Messages by Operation Id.
Example: operation_01h9krwprkeee8fzqspvwy6nq8
conversationId?: string
Filter Messages by Conversation Id.
Example: conversation_01h9krwprkeee8fzqspvwy6nq8
startDate?: Date
Filter to Messages created after the specified date and time.
endDate?: Date
Filter to Messages created before the specified date and time.
toContact?: string
Filter Messages by the Contact Id of the recipient.
Example: 01h9krwprkeee8fzqspvwy6nq8
fromContact?: string
Filter Messages by the Contact Id of the sender.
Example: 01h9krwprkeee8fzqspvwy6nq8
fromAddress?: string
Filter Messages sent from an address.
toAddress?: string
Filter Messages sent to an address.
channel?: components.MessageChannel
Filter Messages by channel.
Example: tel
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ListMessagesResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listMessagesResponse?: operations.ListMessagesListMessagesResponse
OK
Show child properties
headers: Record<string, *string*[]>
Messages
Fetch One Message
This operation fetches a single Message using its id.
Parameters
messageId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchOneMessageResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
message?: components.Message
OK
Show child properties
headers: Record<string, *string*[]>
Messages
Delete Message
This operation deletes a Message
Parameters
messageId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.DeleteMessageResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
headers: Record<string, *string*[]>
Messages
List Message Operations
This operation fetches a paginated list of Message Operations.
Parameters
startDate?: Date
Filter to Operations created after the specified date and time.
endDate?: Date
Filter to Operations created before the specified date and time.
status?: components.MessageOperationStatus
Filter to Operations with the specified status.
Show child properties
| Name | Value |
|---|---|
processing | processing |
completed | completed |
canceled | canceled |
failed | failed |
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ListMessageOperationsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listMessageOperationsResponse?: operations.ListMessageOperationsListMessageOperationsResponse
OK
Show child properties
headers: Record<string, *string*[]>
Messages
Fetch One Message Operation
This operation fetches a single Message Operation using its id.
Parameters
operationId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchOneMessageOperationResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
messageOperation?: components.MessageOperation
OK
Show child properties
headers: Record<string, *string*[]>
Messages
Cancel Message Operation
This operation cancels a Message Operation using its id.
Parameters
operationId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.CancelMessageOperationResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
messageOperation?: components.MessageOperation
OK
Show child properties
headers: Record<string, *string*[]>
Push Notifications
*Use PushNotifications to send push notifications to your mobile apps via Firebase Cloud Messaging and Apple Push Notification services as well as other push-enabled services.*
Available Operations
- Send Push Notifications - Send Push Notifications
- List Push Notifications - List Push Notifications
- Fetch One Push Notification - Fetch a PushNotification
- Delete Push Notification - Delete a PushNotification
- List Push Notification Operations - List Push Notification Operations
- Fetch One Push Notification Operation - Fetch a Push Notification Operation
- Cancel Push Notification Operation - Cancel a Push Notification Operation
Push Notifications
Send Push Notifications
This operation creates and sends out push notifications to the specified recipients.
Parameters
request: operations.SendPushNotificationsSendPushNotificationsRequest
The request object to use for the request.
Show child properties
to: *operations.SendPushNotificationsRecipient*[]
A list of recipients to send the push notifications(s) to.
content: operations.SendPushNotificationsContent
The content of the Push Notification.
- Use PushNotificationContent to construct the content of your Push Notification.
- Use PushNotificationContentOTP to send a PushNotification with an OTP to Verify your recipient.
- Use PushNotificationContentTemplate to reference a stored Content template.
priority?: components.PushNotificationPriority
The priority of the Push Notification. A value of "low" reduces the client app battery consumption. A value of "high" sends the notification immediately and can wake up a sleeping device.
Show child properties
sound?: string
The name of the sound to be played for the push notification.
timeToDeliver?: components.PushNotificationTimeToDeliver
How long the notification delivery is attempted.
processingOptions?: operations.SendPushNotificationsRequestProcessingOptions
Additional options to control how the Push Notification is processed.
Show child properties
tags?: Record<string, components.Tags>
Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 128 characters. There can be a maximum of 10 key-value pairs.
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.SendPushNotificationsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
sendPushNotificationsResponse?: operations.SendPushNotificationsSendPushNotificationsResponse
Created
Show child properties
headers: Record<string, *string*[]>
Push Notifications
List Push Notifications
This operation fetches a paginated list of Push Notifications.
Parameters
request: operations.ListPushNotificationsRequest
The request object to use for the request.
Show child properties
operationId?: string
Filter Push Notifications by Operation Id.
Example: operation_01h9krwprkeee8fzqspvwy6nq8
conversationId?: string
Filter Push Notifications by Conversation Id.
Example: conversation_01h9krwprkeee8fzqspvwy6nq8
startDate?: Date
Filter to Push Notifications created after the specified date and time.
endDate?: Date
Filter to Push Notifications created before the specified date and time.
toContact?: string
Filter Push Notifications sent to a specific Contact.
Example: contact_01h9krwprkeee8fzqspvwy6nq8
toAddress?: string
Filter Push Notifications sent to an address.
channel?: components.PushNotificationChannel
Filter Push Notifications by channel.
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ListPushNotificationsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listPushNotificationsResponse?: operations.ListPushNotificationsListPushNotificationsResponse
OK
Show child properties
headers: Record<string, *string*[]>
Push Notifications
Fetch One Push Notification
This operation fetches a single Push Notification using its id.
Parameters
pushNotificationId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchOnePushNotificationResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
pushNotification?: components.PushNotification
OK
Show child properties
headers: Record<string, *string*[]>
Push Notifications
Delete Push Notification
This operation deletes a Push Notification
Parameters
pushNotificationId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.DeletePushNotificationResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
headers: Record<string, *string*[]>
Push Notifications
List Push Notification Operations
This operation fetches a paginated list of Push Notification Operations.
Parameters
startDate?: Date
Filter to Operations created after the specified date and time.
endDate?: Date
Filter to Operations created before the specified date and time.
status?: components.PushNotificationOperationStatus
Filter to Operations with the specified status.
Show child properties
| Name | Value |
|---|---|
processing | processing |
completed | completed |
canceled | canceled |
failed | failed |
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ListPushNotificationOperationsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listPushNotificationOperationsResponse?: operations.ListPushNotificationOperationsListPushNotificationOperationsResponse
OK
Show child properties
headers: Record<string, *string*[]>
Push Notifications
Fetch One Push Notification Operation
This operation fetches a single Push Notification Operation using its id.
Parameters
operationId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchOnePushNotificationOperationResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
pushNotificationOperation?: components.PushNotificationOperation
OK
Show child properties
headers: Record<string, *string*[]>
Push Notifications
Cancel Push Notification Operation
This operation cancels a Push Notification Operation using its id.
Parameters
operationId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.CancelPushNotificationOperationResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
pushNotificationOperation?: components.PushNotificationOperation
OK
Show child properties
headers: Record<string, *string*[]>
Communications
*Use Communications to send and receive 1:1 omni-channel communications across all channels of all communication types. Reach each and every customer with personalized content, on the right channel, at the optimal time, at scale. Just send it!*
Available Operations
- Send Communications - Send Communications
- List Communications - List Communications
- Fetch Single Communication - Fetch a Communication
- Delete Communication - Delete a Communication
- List Communication Operations - List Communication Operations
- Fetch One Communication Operation - Fetch an Communication Operation
- Cancel Communication Operation - Cancel an Communication Operation
Communications
Send Communications
This operation sends omni-channel communications to audiences across all channels. This operation can also be used to directly send Messages, Emails, and Push Notifications.
Parameters
request: operations.SendCommunicationsSendCommunicationsRequest
The request object to use for the request.
Show child properties
from?: operations.SendCommunicationsRequestFrom
The sending identity to associate with the Communication(s). To send across multiple channels, use an AgentAddressee.
to: *operations.SendCommunicationsRequestRecipient*[]
A list of recipients to send the Communication(s) to.
content: operations.SendCommunicationsContent
The content of the communication - including text, media, body (MIMEs), and content transformation options.
processingOptions?: components.ProcessingOptions
Optional processing directives, specific to the related resources to be created.
Show child properties
tags?: Record<string, components.Tags>
Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 128 characters. There can be a maximum of 10 key-value pairs.
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.SendCommunicationsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
sendCommunicationsResponse?: operations.SendCommunicationsSendCommunicationsResponse
Created
Show child properties
headers: Record<string, *string*[]>
Communications
List Communications
This operation fetches a paginated list of Communications.
Parameters
request: operations.ListCommunicationsRequest
The request object to use for the request.
Show child properties
operationId?: string
Filter to Communications created in a specific Operation.
Example: operation_01h9krwprkeee8fzqspvwy6nq8
conversationId?: string
Filter to Communications created in a specific Conversation.
Example: conversation_01h9krwprkeee8fzqspvwy6nq8
startDate?: Date
Filter to Communications created after the specified date and time.
endDate?: Date
Filter to Communications created before the specified date and time.
toContact?: string
Filter to Communications sent to a specific Contact.
Example: contact_01h9krwprkeee8fzqspvwy6nq8
toAddress?: string
Filter to Communications sent to a specific address.
channel?: components.CommunicationChannel
Filter to Communications that match a specific channel.
Show child properties
communicationType?: components.CommunicationType
Filter to Communications that match a specific type.
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ListCommunicationsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listCommunicationsResponse?: operations.ListCommunicationsListCommunicationsResponse
OK
Show child properties
headers: Record<string, *string*[]>
Communications
Fetch Single Communication
This operation fetches a single Communication using its Id.
Parameters
communicationId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchSingleCommunicationResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
communication?: components.Communication
OK
Show child properties
headers: Record<string, *string*[]>
Communications
Delete Communication
This operation deletes a Communication
Parameters
communicationId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.DeleteCommunicationResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
headers: Record<string, *string*[]>
Communications
List Communication Operations
This operation fetches a paginated list of Communication Operations.
Parameters
startDate?: Date
Filter to Operations created after the specified date and time.
endDate?: Date
Filter to Operations created before the specified date and time.
status?: components.CommunicationOperationStatus
Filter to Operations with the specified status.
Show child properties
| Name | Value |
|---|---|
processing | processing |
completed | completed |
canceled | canceled |
failed | failed |
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ListCommunicationOperationsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listCommunicationOperationsResponse?: operations.ListCommunicationOperationsListCommunicationOperationsResponse
OK
Show child properties
headers: Record<string, *string*[]>
Communications
Fetch One Communication Operation
This operation fetches a single Communication Operation using its id.
Parameters
operationId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchOneCommunicationOperationResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
communicationOperation?: components.CommunicationOperation
OK
Show child properties
headers: Record<string, *string*[]>
Communications
Cancel Communication Operation
This operation cancels an Communication Operation using its Id.
Parameters
operationId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.CancelCommunicationOperationResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
communicationOperation?: components.CommunicationOperation
OK
Show child properties
headers: Record<string, *string*[]>
Agents And Agent Pools
*Use Agents to build the sending and receiving identities that represent your business & applications.*
- For 'outbound' communications, it is used as the sender of the commmunication (from field).
- For 'inbound' communications to your app (sent by a Contact/end-user), it is used as the recipient (to field).
- Use AgentPools to organize your Agents into logical groups to build omni-channel identities with multiple types of communications addresses (phone numbers, short codes, email addresses).
Available Operations
- Create Agent - Create an Agent
- List Agents - List Agents
- Fetch One Agent - Fetch an Agent
- Update Agent - Update an Agent
- Delete Agent - Delete an Agent
- Create Agent Pool - Create an AgentPool
- List Agent Pools - List AgentPools
- Fetch One Agent Pool - Fetch an AgentPool
- Update Agent Pool - Update an AgentPool
- Delete Agent Pool - Delete an AgentPool
- Add Agent To Agent Pool - Add Agent to an AgentPool
- List Agents In Agent Pool - List Agents in AgentPool
- Remove Agent From Agent Pool - Remove Agent from AgentPool
Agents & Agent Pools
Create Agent
This operation creates an Agent.
Parameters
request: operations.CreateAgentCreateAgent
The request object to use for the request.
Show child properties
id?: string
A reference to an Agent.
Example: agent_01h9krwprkeee8fzqspvwy6nq8
firstName?: string
The first_name of the Agent
lastName?: string
The last name of the Agent
displayName?: string
The name to associate with the address for sending and receiving communications, visible to external contacts for some types of communications like email.
address: string
The identifier within a channel address space for an actor (e.g. phone number)
channel: components.CommunicationChannel
The medium which a unit of communication is transmitted through. These are differentiated by a mix of transmission protocol, network controller/owner, endpoint and address model, as well as the model for content of the atomic unit of communication itself.
Show child properties
tags?: Record<string, components.Tags>
Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 128 characters. There can be a maximum of 10 key-value pairs.
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.CreateAgentResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
agent?: components.Agent
Created
Show child properties
headers: Record<string, *string*[]>
Agents & Agent Pools
List Agents
This operation fetches a paginated list of Agents.
Parameters
channel?: components.CommunicationChannel
Filter to Representatives that match a specific channel.
Show child properties
| Name | Value |
|---|---|
email | |
tel | tel |
whatsapp | |
fbm | fbm |
gbm | gbm |
chat | chat |
apn | apn |
fcm | fcm |
startDate?: Date
Filter to Representatives created after the specified date and time.
endDate?: Date
Filter to Representatives created before the specified date and time.
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ListAgentsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listAgentsResponse?: operations.ListAgentsListAgentsResponse
OK
Show child properties
headers: Record<string, *string*[]>
Agents & Agent Pools
Fetch One Agent
This operation fetches a single Agent using its id.
Parameters
agentId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchOneAgentResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
agent?: components.Agent
OK
Show child properties
headers: Record<string, *string*[]>
Agents & Agent Pools
Update Agent
This operation partially updates an Agent
Parameters
agentId: string
Example: [object Object]
requestBody?: operations.UpdateAgentUpdateAgentRequest
Show child properties
firstName?: string
The first_name of the Agent
lastName?: string
The last name of the Agent
displayName?: string
The name to associate with the address for sending and receiving communications, visible to external contacts for some types of communications like email.
address?: string
The identifier within a channel address space for an actor (e.g. phone number)
channel?: components.CommunicationChannel
The medium which a unit of communication is transmitted through. These are differentiated by a mix of transmission protocol, network controller/owner, endpoint and address model, as well as the model for content of the atomic unit of communication itself.
Show child properties
tags?: Record<string, components.Tags>
Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 128 characters. There can be a maximum of 10 key-value pairs.
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.UpdateAgentResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
agent?: components.Agent
Ok
Show child properties
headers: Record<string, *string*[]>
Agents & Agent Pools
Delete Agent
This operation deletes an Agent
Parameters
agentId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.DeleteAgentResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
headers: Record<string, *string*[]>
Agents & Agent Pools
Create Agent Pool
This operation creates an AgentPool
Parameters
request: operations.CreateAgentPoolCreateAgentPoolRequest
The request object to use for the request.
Show child properties
friendlyName?: string
tags?: Record<string, components.Tags>
Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 128 characters. There can be a maximum of 10 key-value pairs.
Show child properties
stickySenderEnabled?: boolean
geomatch?: operations.AgentSettingsGeomatch
Show child properties
channelRank?: operations.AgentSettingsChannelRankItem[]
The rank provides a priority ordering for address selection for use in some operations. The lower the rank, the more preferred the channel.
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.CreateAgentPoolResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
agentPool?: components.AgentPool
Created
Show child properties
headers: Record<string, *string*[]>
Agents & Agent Pools
List Agent Pools
This operation fetches a paginated list of AgentPools.
Parameters
channel?: components.CommunicationChannel
Filter to AgentPools that match a specific channel.
Show child properties
| Name | Value |
|---|---|
email | |
tel | tel |
whatsapp | |
fbm | fbm |
gbm | gbm |
chat | chat |
apn | apn |
fcm | fcm |
startDate?: Date
Filter to AgentPools created after the specified date and time.
endDate?: Date
Filter to AgentPools created before the specified date and time.
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ListAgentPoolsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listAgentPoolsResponse?: operations.ListAgentPoolsListAgentPoolsResponse
OK
Show child properties
headers: Record<string, *string*[]>
Agents & Agent Pools
Fetch One Agent Pool
This operation fetches a single AgentPool using its id.
Parameters
agentPoolId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchOneAgentPoolResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
agentPool?: components.AgentPool
OK
Show child properties
headers: Record<string, *string*[]>
Agents & Agent Pools
Update Agent Pool
This operation partially updates an AgentPool
Parameters
agentPoolId: string
Example: [object Object]
requestBody?: operations.UpdateAgentPoolUpdateAgentPoolRequest
Show child properties
friendlyName?: string
The friendly name of the AgentPool
tags?: Record<string, components.Tags>
Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 128 characters. There can be a maximum of 10 key-value pairs.
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.UpdateAgentPoolResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
agentPool?: components.AgentPool
Ok
Show child properties
headers: Record<string, *string*[]>
Agents & Agent Pools
Delete Agent Pool
This operation deletes an AgentPool
Parameters
agentPoolId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.DeleteAgentPoolResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
headers: Record<string, *string*[]>
Agents & Agent Pools
Add Agent To Agent Pool
This operation adds an Agent to an AgentPool
Parameters
agentPoolId: string
Example: [object Object]
requestBody?: operations.AddAgentToAgentPoolAddAgentToAgentPoolRequest
Show child properties
agentId?: string
A reference to an Agent.
Example: agent_01h9krwprkeee8fzqspvwy6nq8
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.AddAgentToAgentPoolResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
agentPool?: components.AgentPool
Created
Show child properties
headers: Record<string, *string*[]>
Agents & Agent Pools
List Agents In Agent Pool
This operation fetches a paginated list of Agents that belong to a AgentPool.
Parameters
agentPoolId: string
Example: [object Object]
channel?: components.CommunicationChannel
Filter to Agents that match a specific channel.
Show child properties
| Name | Value |
|---|---|
email | |
tel | tel |
whatsapp | |
fbm | fbm |
gbm | gbm |
chat | chat |
apn | apn |
fcm | fcm |
startDate?: Date
Filter to Agents created after the specified date and time.
endDate?: Date
Filter to Agents created before the specified date and time.
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ListAgentsInAgentPoolResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listAgentsInAgentPoolResponse?: operations.ListAgentsInAgentPoolListAgentsInAgentPoolResponse
OK
Show child properties
headers: Record<string, *string*[]>
Agents & Agent Pools
Remove Agent From Agent Pool
This operation removes an Agent from an AgentPool
Parameters
agentPoolId: string
Example: [object Object]
agentId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.RemoveAgentFromAgentPoolResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
headers: Record<string, *string*[]>
Domains
Available Operations
- Create Domain - Create a Domain
- List Domains - List Domains
- Fetch One Domain - Fetch a Domain
- Update Domain - Update a Domain
- Check Domain - Check a Domain
Domains
Create Domain
This operation creates a Domain. Verification of your Domain is required before you can use it. See 'Check a Domain' next.
Parameters
request: operations.CreateDomainCreateDomainRequest
The request object to use for the request.
Show child properties
domainName: string
A fully qualified domain name (FQDN) that you have registered with your DNS provider.
Example: example.com
capabilities?: components.DomainCapability[]
The capabilities that the Domain should be configured for.
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.CreateDomainResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
domain?: components.Domain
OK
Show child properties
headers: Record<string, *string*[]>
Domains
List Domains
This operation fetches a paginated list of Domains. Domains are used to authenticate domain names and configure DNS records for sending Email and communication links.
Parameters
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ListDomainsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listDomainsResponse?: operations.ListDomainsListDomainsResponse
OK
Show child properties
headers: Record<string, *string*[]>
Domains
Fetch One Domain
This operation fetches a Domain by its unique identifier.
Parameters
domainId: string
The unique identifier for the Domain.
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchOneDomainResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
domain?: components.Domain
OK
Show child properties
headers: Record<string, *string*[]>
Domains
Update Domain
This operation updates a Domain by its unique identifier.
Parameters
domainId: string
The unique identifier for the Domain.
Example: [object Object]
requestBody?: operations.UpdateDomainUpdateDomainRequest
Show child properties
isDefault?: boolean
Whether this is the default Domain. Only one Domain can be the default Domain.
capabilities?: components.DomainCapability[]
The capabilities that the Domain should be configured for.
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.UpdateDomainResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
domain?: components.Domain
OK
Show child properties
headers: Record<string, *string*[]>
Domains
Check Domain
This operation triggers Twilio to check the verification status of a Domain. Verification of a Domain is required before you can use it.
Parameters
domainId: string
The unique identifier for the Domain.
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.CheckDomainResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
domain?: components.Domain
OK
Show child properties
headers: Record<string, *string*[]>
Content And Media
*Use Content & Media to build, store, and retrieve reusable content templates and media files.*
Available Operations
- Upload Media - Upload Media
- List Media - List Media
- Fetch Single Media - Fetch a Media
Content & Media
Upload Media
This operation uploads a Media file.
Parameters
request: operations.UploadMediaUploadMediaJSONRequest
The request object to use for the request.
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.UploadMediaResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
media?: components.Media
Created
Show child properties
headers: Record<string, *string*[]>
Content & Media
List Media
This operation fetches a paginated list of Media.
Parameters
request: operations.ListMediaRequest
The request object to use for the request.
Show child properties
startDate?: Date
Filter to Media created after the specified date and time.
endDate?: Date
Filter to Media created before the specified date and time.
uploadStatus?: components.MediaUploadStatus
Filter to Media with the specified upload status.
Show child properties
mimeType?: string
Filter to Media with the specified MIME type.
Example: text/plain
createdBy?: components.MediaAuthor
Filter to Media created by author.
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ListMediaResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listMediaResponse?: operations.ListMediaListMediaResponse
OK
Show child properties
headers: Record<string, *string*[]>
Content & Media
Fetch Single Media
This operation fetches a single Media object using its ID.
Parameters
mediaId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchSingleMediaResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
media?: components.Media
OK
Show child properties
headers: Record<string, *string*[]>
Event Subscriptions
*Use Event Subscriptions, Sinks, and Schemas to tap into a unified stream of every interaction sent or received on Twilio.*
- Stream your data to your existing systems by configuring a modern,
persistent streaming technology like Amazon Kinesis or to a webhook.
- Easily consume and leverage data from multiple Twilio products with consistent metadata, well-defined and versioned schemas, and control over which events you want delivered.
- Trust that your events will be queued if your system goes down and delivered as soon as it's back up with event queuing for up to 24 hours or 5M events.
Available Operations
- Create Subscription - Create Subscription
- Get Subscriptions - List Subscriptions
- Fetch Single Subscription - Fetch a Subscription
- Update Single Subscription - Update a Subscription
- Get Sinks - List Sinks
- Create Sink - Create a Sink
- Get Schemas - List Event Schemas
- Read Schemas By Type - List Event Schemas by Event Type
- Fetch Event Schema Raw - Fetch Raw Event Schema
Event Subscriptions
Create Subscription
This operation creates an event subscription.
Parameters
request: operations.CreateSubscriptionCreateSubscriptionRequest
The request object to use for the request.
Show child properties
enabled?: boolean
Whether to enable the Subscription upon creation.
filters?: operations.CreateSubscriptionFilters
A set of filters that describe which events to subscribe to. The Subscription will only enable event flow for events that match the filters.
Show child properties
sinks?: operations.CreateSubscriptionSinks
A set of sinks that describe where to send events that match the Subscription's filters. Events 'flow' from source to sink.
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.CreateSubscriptionResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
subscription?: components.Subscription
Created
Show child properties
headers: Record<string, *string*[]>
Event Subscriptions
Get Subscriptions
This operation fetches a paginated list of event Subscriptions.
Parameters
enabled?: boolean
Filter to Subscriptions by their enabled state.
startDate?: Date
Filter to Subscriptions created after the specified date and time.
endDate?: Date
Filter to Subscriptions created before the specified date and time.
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.GetSubscriptionsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listSubscriptionsResponse?: operations.GetSubscriptionsListSubscriptionsResponse
OK
Show child properties
headers: Record<string, *string*[]>
Event Subscriptions
Fetch Single Subscription
This operation fetches a single event Subscription using its Id.
Parameters
subscriptionId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchSingleSubscriptionResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
subscription?: components.Subscription
OK
Show child properties
headers: Record<string, *string*[]>
Event Subscriptions
Update Single Subscription
This operation updates an event Subscription using its Id.
Parameters
subscriptionId: string
requestBody?: operations.UpdateSingleSubscriptionUpdateSubscriptionRequest
Show child properties
enabled?: boolean
filters?: operations.UpdateSubscriptionFilters
Show child properties
sinks?: operations.UpdateSubscriptionSinks
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.UpdateSingleSubscriptionResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
subscription?: components.Subscription
OK
Show child properties
headers: Record<string, *string*[]>
Event Subscriptions
Get Sinks
This operation fetches a paginated list of event Sinks (destinations for event Subscriptions).
Parameters
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.GetSinksResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listSinksResponse?: operations.GetSinksListSinksResponse
OK
Show child properties
headers: Record<string, *string*[]>
Event Subscriptions
Create Sink
This operation creates an event Sink (destination for an event Subscription)
Parameters
request: operations.CreateSinkCreateSinkRequest
The request object to use for the request.
Show child properties
name?: string
configuration?: operations.CreateSinkRequestConfiguration
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.CreateSinkResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
sink?: components.Sink
Created
Show child properties
headers: Record<string, *string*[]>
Event Subscriptions
Get Schemas
This operation fetches a paginated list of event Schemas.
Parameters
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.GetSchemasResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listEventSchemasResponse?: operations.GetSchemasListEventSchemasResponse
OK
Show child properties
headers: Record<string, *string*[]>
Event Subscriptions
Read Schemas By Type
This operation fetches a paginated list of event Schemas using their event type.
Parameters
eventType: string
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ReadSchemasByTypeResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listEventSchemasByEventTypeResponse?: operations.ReadSchemasByTypeListEventSchemasByEventTypeResponse
OK
Show child properties
headers: Record<string, *string*[]>
Event Subscriptions
Fetch Event Schema Raw
This operation fetches a raw event Schema using its type and version.
Parameters
eventType: string
versionId: string
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchEventSchemaRawResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
body?: Uint8Array
fetchEventSchemaRawResponseJSON?: operations.FetchEventSchemaRawFetchEventSchemaRawResponseJSON
OK
Show child properties
headers: Record<string, *string*[]>
Conversations
*Use Conversations to build engaging conversational messaging experiences across all communication types and all channels. Use directly with Messages, Emails, PushNotifications, and Communications to support two-way conversations with your customers*
Available Operations
- List Conversations - List Conversations
- Patch Conversation - Update a Conversation
- Fetch One Conversation - Fetch a Conversation
- Create Participant - Create a Participant
- List Participants - List Participants
- Fetch Single Participant - Fetch a Participant
Conversations
List Conversations
This operation fetches a paginated list of Conversations.
Parameters
request: operations.ListConversationsRequest
The request object to use for the request.
Show child properties
state?: components.ConversationState
Filter to Conversations with the specified state.
Show child properties
participantChannels?: components.CommunicationChannel[]
Filter to Conversations with participants that have the specified channels.
Show child properties
startDate?: Date
Filter to Conversations created after the specified date and time.
endDate?: Date
Filter to Conversations created before the specified date and time.
updatedDate?: Date
Filter to Conversations updated after the specified date and time.
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ListConversationsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listConversationsResponse?: operations.ListConversationsListConversationsResponse
OK
Show child properties
headers: Record<string, *string*[]>
Conversations
Patch Conversation
This operation partially updates a Conversation.
Parameters
conversationId: string
Example: [object Object]
requestBody?: operations.PatchConversationUpdateConversationRequest
Show child properties
title?: string
The title of the conversation.
state?: components.UpdateConversationState
Show child properties
timeTo?: operations.UpdateConversationTimeToStateTransition
The time at which the conversation will be transitioned to a new lifecycle state.
Show child properties
tags?: Record<string, components.Tags>
Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 128 characters. There can be a maximum of 10 key-value pairs.
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.PatchConversationResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
conversation?: components.Conversation
OK
Show child properties
headers: Record<string, *string*[]>
Conversations
Fetch One Conversation
This operation fetches a single Conversation using its id.
Parameters
conversationId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchOneConversationResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
conversation?: components.Conversation
OK
Show child properties
headers: Record<string, *string*[]>
Conversations
Create Participant
This operation creates a Participant
Parameters
conversationId: string
Example: [object Object]
requestBody?: operations.CreateParticipantCreateParticipantRequest
Show child properties
agentId?: string
A reference to an Agent.
Example: agent_01h9krwprkeee8fzqspvwy6nq8
contactId?: string
A reference to a Contact.
Example: contact_01h9krwprkeee8fzqspvwy6nq8
addresses?: components.CommunicationAddress[]
Show child properties
lastReadMessage?: operations.CreateParticipantRequestLastReadMessage
Show child properties
tags?: Record<string, components.Tags>
Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 128 characters. There can be a maximum of 10 key-value pairs.
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.CreateParticipantResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
participant?: components.Participant
Created
Show child properties
headers: Record<string, *string*[]>
Conversations
List Participants
This operation fetches a paginated list of Participants.
Parameters
conversationId: string
Example: [object Object]
channel?: components.CommunicationChannel
Filter to Participants that match a specific channel.
Show child properties
| Name | Value |
|---|---|
email | |
tel | tel |
whatsapp | |
fbm | fbm |
gbm | gbm |
chat | chat |
apn | apn |
fcm | fcm |
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ListParticipantsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listParticipantsResponse?: operations.ListParticipantsListParticipantsResponse
OK
Show child properties
headers: Record<string, *string*[]>
Conversations
Fetch Single Participant
This operation fetches a single conversation participant using its ID.
Parameters
conversationId: string
Example: [object Object]
participantId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchSingleParticipantResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
participant?: components.Participant
OK
Show child properties
headers: Record<string, *string*[]>
Identity Verification
*Fight fraud and protect user accounts. Quickly verify users with OTP over any communication type (Message, Email, PushNotification), and with convenient methods like Passkeys, TOTP, and Silent Device Approval*
Available Operations
- Start Verification - Start a Verification
- List Verifications - List Verifications
- Fetch Verification Settings - Fetch Verification Settings
- Update Verifications Settings - Update Verifications Settings
- Fetch Single Verification - Fetch a Verification
- Delete Verification - Delete a Verification
- Approve Verification - Approve a Verification
- Cancel Verification - Cancel a Verification
- Check Verification - Check a Verification
- Create Factor - Create a Factor
- List Factors - List Factors
- Update Factor - Update a Factor
- Fetch Single Factor - Fetch a Factor
Identity Verification
Start Verification
This operation initiates a Verification session.
Parameters
request: operations.StartVerificationStartVerificationRequest
The request object to use for the request.
Show child properties
from?: operations.StartVerificationRequestFrom
The sending identity to associate with a Verification communication. To have Twilio optimize across multiple communication channels, use an AgentPool.
to?: operations.StartVerificationRequestTo
The user to Verify.
- Use OTPRecipient to verify a user with an OTP communication at a specific address.
- Use OTPCallRecipient to verify a user with an OTP over voice call.
- Use FactorRecipient to verify a user with a Verify Factor.
- Use SilentNetworkAuthRecipient to verify a user with a Silent Network Authentication.
- Use OmniVerificationRecipient to verify a known Contact with an optimal method.
content?: operations.VerificationContentInput
The content of the Verification communication.
- For default content template, Twilio-generated OTP, and optional overrides use DefaultVerificationContent or leave empty.
- For custom content use a communication type-specific content or OmniChannelContentInput.
processingOptions?: components.ProcessingOptions
Optional processing directives, specific to the related resources to be created.
Show child properties
tags?: Record<string, components.Tags>
Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 128 characters. There can be a maximum of 10 key-value pairs.
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.StartVerificationResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
verification?: components.Verification
Created
Show child properties
headers: Record<string, *string*[]>
Identity Verification
List Verifications
This operation fetches a paginated list of Verifications.
Parameters
request: operations.ListVerificationsRequest
The request object to use for the request.
Show child properties
status?: components.VerificationStatus
Filter to Verifications that match a specific status.
Show child properties
factorType?: components.FactorType
Filter to Verifications that match a specific recipient factor type.
Show child properties
contactId?: string
Filter to Verifications for a specific Contact.
Example: contact_01h9krwprkeee8fzqspvwy6nq8
userIdentifier?: string
Filter to Verifications for a specific user_identifier.
channel?: components.CommunicationChannel
Filter to Verifications that match a specific channel.
Show child properties
startDate?: Date
Filter to Verifications created after the specified date and time.
endDate?: Date
Filter to Verifications created before the specified date and time.
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ListVerificationsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listVerificationsResponse?: operations.ListVerificationsListVerificationsResponse
OK
Show child properties
headers: Record<string, *string*[]>
Identity Verification
Fetch Verification Settings
This operation fetches the current Verification settings.
Parameters
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchVerificationSettingsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
verificationsSettings?: operations.FetchVerificationSettingsVerificationsSettings
OK
Show child properties
headers: Record<string, *string*[]>
Identity Verification
Update Verifications Settings
This operation partially updates the current Verifications resoure collection settings.
Parameters
request: components.VerificationsSettings
The request object to use for the request.
Show child properties
fraudGuardLevel?: components.FraudGuardLevel
The level of fraud protection to apply to the Verification.
- none - No fraud protection is applied.
- basic - Cautious fraud protection is applied.
- standard - Standard fraud protection is applied.
- maximum - Maximum fraud protection is applied.
Show child properties
timeToExpire?: string
The duration of time, in ISO 8601 duration format, after which Verifications automatically expire.
Example: PT10M
timeToDelete?: string
The duration of time, in ISO 8601 duration format, after which Verifications are automatically deleted.
Example: P30D
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.UpdateVerificationsSettingsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
verificationsSettings?: components.VerificationsSettings
OK
Show child properties
headers: Record<string, *string*[]>
Identity Verification
Fetch Single Verification
This operation fetches a single Verification using its Id.
Parameters
verificationId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchSingleVerificationResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
verification?: components.Verification
OK
Show child properties
headers: Record<string, *string*[]>
Identity Verification
Delete Verification
This operation deletes a Verification
Parameters
verificationId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.DeleteVerificationResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
headers: Record<string, *string*[]>
Identity Verification
Approve Verification
This operation approves a Verification
Parameters
verificationId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ApproveVerificationResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
verification?: components.Verification
OK
Show child properties
headers: Record<string, *string*[]>
Identity Verification
Cancel Verification
This operation cancels a Verification
Parameters
verificationId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.CancelVerificationResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
verification?: components.Verification
OK
Show child properties
headers: Record<string, *string*[]>
Identity Verification
Check Verification
This operation checks a Verification
Parameters
verificationId: string
Example: [object Object]
requestBody?: operations.CheckVerificationVerificationCheckRequest
Show child properties
code?: string
The 4-10 character string being verified.
amount?: string
The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
payee?: string
The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.CheckVerificationResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
verification?: components.Verification
OK
Show child properties
headers: Record<string, *string*[]>
Identity Verification
Create Factor
This operation creates a Factor.
Parameters
request: operations.CreateFactorCreateFactorRequest
The request object to use for the request.
Show child properties
type: components.FactorType
The type of Verification Factor.
Show child properties
friendlyName?: string
A human-readable description of the Factor. Maximum length is 255 characters.
userIdentifier?: string
A custom string that identifies the end-user challenged for verification. E.g. an MD5 hash of your internal ID for this user.
contactId?: string
A reference to a Contact.
Example: contact_01h9krwprkeee8fzqspvwy6nq8
config: operations.CreateFactorConfiguration
The configuration of the Factor. The configuration is a JSON object that varies depending on the Factor type. See the Factor Configuration section for more information.
Show child properties
tags?: Record<string, components.Tags>
Custom metadata in the form of key-value pairs. Maximum size of a tag key is 128 characters. Maximum size of a tag value is 128 characters. There can be a maximum of 10 key-value pairs.
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.CreateFactorResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
factor?: components.Factor
Created
Show child properties
headers: Record<string, *string*[]>
Identity Verification
List Factors
This operation fetches a paginated list of Factors.
Parameters
request: operations.ListFactorsRequest
The request object to use for the request.
Show child properties
contactId?: string
Filter Factors by Contact Id.
Example: contact_01h9krwprkeee8fzqspvwy6nq8
type?: components.FactorType
Filter Factors by type.
Show child properties
status?: components.FactorStatus
Filter Factors by status.
Show child properties
friendlyName?: string
Filter Factors by friendly name.
startDate?: Date
Filter to Factors created after the specified date and time.
endDate?: Date
Filter to Factors created before the specified date and time.
sortBy?: string
Sort Factors by the specified field.
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.ListFactorsResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
listFactorsResponse?: operations.ListFactorsListFactorsResponse
OK
Show child properties
headers: Record<string, *string*[]>
Identity Verification
Update Factor
This operation partially updates a Factor.
Parameters
factorId: string
Example: [object Object]
requestBody?: operations.UpdateFactorUpdateFactorRequest
Show child properties
friendlyName?: string
A human-readable description of the Factor. Maximum length is 255 characters.
contactId?: string
A reference to a Contact.
Example: contact_01h9krwprkeee8fzqspvwy6nq8
userIdentifier?: string
A custom string that identifies the end-user challenged for verification. E.g. an MD5 hash of your internal ID for this user.
status?: components.FactorStatus
The verification status of the Factor.
- unverified: The Factor is not yet verified and cannot be used in a Verification session.
- verified: The Factor is verified and can be used in a Verification session.
- expired: The Factor is expired and cannot be used in a Verification session.
Show child properties
authPayload?: string
The optional payload needed to verify the Factor for the first time. E.g. for a totp, the numeric code.
config?: operations.FetchFactorConfiguration
The configuration of the Factor. The configuration is a JSON object that varies depending on the Factor type. See the Factor Configuration section for more information.
Show child properties
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.UpdateFactorResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
factor?: components.Factor
OK
Show child properties
headers: Record<string, *string*[]>
Identity Verification
Fetch Single Factor
This operation fetches a single Factor using its Id.
Parameters
factorId: string
Example: [object Object]
options?: RequestOptions
Options for making HTTP requests.
options.fetchOptions?: RequestInit
Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
Response
Promise<operations.FetchSingleFactorResponse>
Hide child properties
contentType: string
HTTP response content type for this operation
statusCode: number
HTTP response status code for this operation
rawResponse: Response
Raw HTTP response; suitable for custom response parsing
factor?: components.Factor
OK