typescript
Resources

API and SDK reference

Installation
TypeScript

NPM

npm add Twilio-Communications-API

Yarn

yarn add Twilio-Communications-API

Custom HTTP Client
TypeScript

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:

import { TwillioSDKDocs } from "Twilio-Communications-API";
import { HTTPClient } from "Twilio-Communications-API/lib/http";

const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`.
fetcher: (request) => {
return fetch(request);
}
});

httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000);
});

nextRequest.headers.set("x-custom-header", "custom value");

return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});

const sdk = new TwillioSDKDocs({ httpClient });

Security Options
TypeScript

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:

import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.addressLookups.createAddressLookups({
addresses: [,],
});

// Handle the result
console.log(result);
}

run();

Errors
TypeScript

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

import { TwillioSDKDocs } from "Twilio-Communications-API";
import * as errors from "Twilio-Communications-API/models/errors";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

let result;
try {
result = await sdk.addressLookups.createAddressLookups({
addresses: [,],
});
} catch (err) {
switch (true) {
case err instanceof errors.TwilioError: {
console.error(err); // handle exception
return;
}
default: {
throw err;
}
}
}

// Handle the result
console.log(result);
}

run();

Server Options
TypeScript

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:

import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
serverIdx: 0,
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.addressLookups.createAddressLookups({
addresses: [,],
});

// Handle the result
console.log(result);
}

run();

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:

import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
serverURL: "https://comms.twilio.com/preview",
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.addressLookups.createAddressLookups({
addresses: [,],
});

// Handle the result
console.log(result);
}

run();

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

Address Lookups

Create Address Lookups

This operation creates AddressLookups

Parameters

TypeScript
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

TypeScript
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*[]>
CreateAddressLookups.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.addressLookups.createAddressLookups({
addresses: [
,
],
});

// Handle the result
console.log(result)
}

run();
Example Response
{
"address_lookups": [
{
"id": "addresslookup_01h9krwprkeee8fzqspvwy6nq8",
"type": "phone_number",
"address": "string",
"calling_country_code": "string",
"country_code": "string",
"phone_number": "string",
"national_format": "string",
"valid": false,
"validation_errors": [],
"caller_name": {},
"sim_swap": {},
"call_forwarding": {},
"live_activity": {},
"line_type_intelligence": {},
"identity_match": {},
"reassigned_number": {},
"sms_pumping_risk": {},
"disposable_phone_number_risk": {},
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"operation_id": "operation_01h9krwprkeee8fzqspvwy6nq8",
"created_at": "2024-07-14T07:33:58.078Z",
"updated_at": "2023-10-23T15:05:15.700Z"
}
]
}
Address Lookups

List Address Lookups

This operation fetches a paginated list of AddressLookups.

Parameters

TypeScript
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

TypeScript
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*[]>
ListAddressLookups.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const address = "string";
const startDate = new Date("2023-08-25T11:59:25.313Z");
const endDate = new Date("2023-10-12T18:11:05.242Z");

const result = await sdk.addressLookups.listAddressLookups(address, startDate, endDate);

// Handle the result
console.log(result)
}

run();
Example Response
{
"address_lookups": [
{
"id": "addresslookup_01h9krwprkeee8fzqspvwy6nq8",
"type": "phone_number",
"address": "string",
"calling_country_code": "string",
"country_code": "string",
"phone_number": "string",
"national_format": "string",
"valid": false,
"validation_errors": [],
"caller_name": {},
"sim_swap": {},
"call_forwarding": {},
"live_activity": {},
"line_type_intelligence": {},
"identity_match": {},
"reassigned_number": {},
"sms_pumping_risk": {},
"disposable_phone_number_risk": {},
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"operation_id": "operation_01h9krwprkeee8fzqspvwy6nq8",
"created_at": "2023-04-10T07:48:56.789Z",
"updated_at": "2023-11-15T10:13:10.092Z"
}
],
"pagination": {
"page": 645894,
"prev": "string",
"next": "string",
"self": "string"
}
}
Address Lookups

Fetch One Address Lookup

This operation fetches a single AddressLookup using its id.

Parameters

TypeScript
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

TypeScript
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*[]>
FetchOneAddressLookup.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const addressLookupId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.addressLookups.fetchOneAddressLookup(addressLookupId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "addresslookup_01h9krwprkeee8fzqspvwy6nq8",
"type": "email",
"address": "string",
"validity_score": 8917.73,
"local": "string",
"domain": "awesome-voter.biz",
"suggestion": "Jasper_Schiller47@yahoo.com",
"checks": {
"domain": [],
"local": [],
"bounces": []
},
"source": "string",
"ip_address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"operation_id": "operation_01h9krwprkeee8fzqspvwy6nq8",
"created_at": "2024-10-11T10:53:37.826Z",
"updated_at": "2024-07-05T08:12:57.367Z"
}

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

Contacts & Audiences

Create Contacts

This operation creates Contacts

Parameters

TypeScript
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

TypeScript
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*[]>
CreateContacts.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.contactsAndAudiences.createContacts({
contacts: [
{
addresses: [
{},
],
location: {},
tags: {
"key": {},
},
},
],
});

// Handle the result
console.log(result)
}

run();
Example Response
{
"contacts": [
{
"first_name": "string",
"last_name": "string",
"display_name": "string",
"user_identifier": "string",
"location": {
"latitude": 710.36,
"longitude": 3373.96,
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country_code": "string"
},
"date_of_birth": "string",
"national_id": "string",
"id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"addresses": [
{
"address": "string",
"is_validated_by_lookup": false,
"last_validated_by_lookup": "2023-12-12T09:30:46.948Z"
}
],
"audiences": [
{
"audience_id": "audience_01h9krwprkeee8fzqspvwy6nq8"
}
],
"tags": {},
"operation_id": "operation_01h9krwprkeee8fzqspvwy6nq8",
"created_at": "2022-01-23T03:49:29.173Z",
"updated_at": "2023-02-08T14:13:31.435Z"
}
]
}
Contacts & Audiences

List Contacts

This operation fetches a paginated list of Contacts.

Parameters

TypeScript
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

TypeScript
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*[]>
ListContacts.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { CommunicationChannel } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.contactsAndAudiences.listContacts({});

// Handle the result
console.log(result)
}

run();
Example Response
{
"contacts": [
{
"first_name": "string",
"last_name": "string",
"display_name": "string",
"user_identifier": "string",
"location": {
"latitude": 8326.2,
"longitude": 9571.56,
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country_code": "string"
},
"date_of_birth": "string",
"national_id": "string",
"id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"addresses": [
{
"address": "string",
"is_validated_by_lookup": false,
"last_validated_by_lookup": "2022-06-03T19:47:12.657Z"
}
],
"audiences": [
{
"audience_id": "audience_01h9krwprkeee8fzqspvwy6nq8"
}
],
"tags": {},
"operation_id": "operation_01h9krwprkeee8fzqspvwy6nq8",
"created_at": "2024-08-11T12:47:58.088Z",
"updated_at": "2024-08-11T14:46:30.188Z"
}
],
"pagination": {
"page": 978619,
"prev": "string",
"next": "string",
"self": "string"
}
}
Contacts & Audiences

Fetch Single Contact

This operation fetches a single contact using its ID.

Parameters

TypeScript
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

TypeScript
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*[]>
FetchSingleContact.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const contactId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.contactsAndAudiences.fetchSingleContact(contactId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"first_name": "string",
"last_name": "string",
"display_name": "string",
"user_identifier": "string",
"location": {
"latitude": 4736.08,
"longitude": 7991.59,
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country_code": "string"
},
"date_of_birth": "string",
"national_id": "string",
"id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"addresses": [
{
"address": "string",
"is_validated_by_lookup": false,
"last_validated_by_lookup": "2023-05-21T18:45:11.373Z"
}
],
"audiences": [
{
"audience_id": "audience_01h9krwprkeee8fzqspvwy6nq8"
}
],
"tags": {},
"operation_id": "operation_01h9krwprkeee8fzqspvwy6nq8",
"created_at": "2023-07-25T10:38:22.728Z",
"updated_at": "2024-05-05T11:02:21.971Z"
}
Contacts & Audiences

Update Contact

This operation partially updates a Contact

Parameters

TypeScript
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

TypeScript
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*[]>
UpdateContact.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const contactId = "01h9krwprkeee8fzqspvwy6nq8";
const requestBody = {
addresses: [
{},
],
tags: {
"key": {},
},
};

const result = await sdk.contactsAndAudiences.updateContact(contactId, requestBody);

// Handle the result
console.log(result)
}

run();
Example Response
{
"first_name": "string",
"last_name": "string",
"display_name": "string",
"user_identifier": "string",
"location": {
"latitude": 6788.8,
"longitude": 1182.74,
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country_code": "string"
},
"date_of_birth": "string",
"national_id": "string",
"id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"addresses": [
{
"address": "string",
"is_validated_by_lookup": false,
"last_validated_by_lookup": "2023-12-03T08:28:56.752Z"
}
],
"audiences": [
{
"audience_id": "audience_01h9krwprkeee8fzqspvwy6nq8"
}
],
"tags": {},
"operation_id": "operation_01h9krwprkeee8fzqspvwy6nq8",
"created_at": "2023-09-30T21:26:54.920Z",
"updated_at": "2022-06-07T02:45:53.358Z"
}
Contacts & Audiences

Delete Contact

This operation deletes a Contact

Parameters

TypeScript
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

TypeScript
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*[]>
DeleteContact.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const contactId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.contactsAndAudiences.deleteContact(contactId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"code": 537373,
"message": "string",
"more_info": "https://sizzling-locust.com"
}
Contacts & Audiences

Update Contacts Settings

This operation partially updates Contacts Settings

Parameters

TypeScript
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

TypeScript
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*[]>
UpdateContactsSettings.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { } from "Twilio-Communications-API/models";
import { LookupOnCreateMode } from "Twilio-Communications-API/models/operations";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.contactsAndAudiences.updateContactsSettings({
autoCreateWith: [
AutoCreateWith.PushNotifications,
],
autoValidateAddresses: {},
});

// Handle the result
console.log(result)
}

run();
Example Response
{
"auto_create_with": [],
"auto_validate_addresses": {
"lookup_refresh_interval": "string"
}
}
Contacts & Audiences

Fetch Contacts Settings

This operation fetches Contacts Settings

Parameters

TypeScript
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

TypeScript
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*[]>
FetchContactsSettings.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.contactsAndAudiences.fetchContactsSettings();

// Handle the result
console.log(result)
}

run();
Example Response
{
"auto_create_with": [],
"auto_validate_addresses": {
"lookup_refresh_interval": "string"
}
}
Contacts & Audiences

Create Preferences

This operation creates Preferences

Parameters

TypeScript
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

TypeScript
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*[]>
CreatePreferences.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.contactsAndAudiences.createPreferences({
name: "string",
channels: [
{},
],
tags: {
"key": {},
},
});

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "cb739205-9293-496f-aa75-96eb10faaa23",
"name": "string",
"description": "string",
"is_public": false,
"channels": [
{
"default_opt_in": false
}
],
"tags": {},
"created_at": "2022-05-22T07:16:38.466Z",
"updated_at": "2024-04-02T18:02:53.509Z",
"deleted_at": "2022-12-12T17:01:38.313Z"
}
Contacts & Audiences

List Preferences

This operation fetches a paginated list of Preferences

Parameters

TypeScript
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

TypeScript
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*[]>
ListPreferences.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.contactsAndAudiences.listPreferences();

// Handle the result
console.log(result)
}

run();
Example Response
{
"preferences": [
{
"id": "955907af-f1a3-4a2f-a946-7739251aa52c",
"name": "string",
"description": "string",
"is_public": false,
"channels": [
{
"default_opt_in": false
}
],
"tags": {},
"created_at": "2024-11-06T17:31:00.970Z",
"updated_at": "2023-02-09T02:56:48.333Z",
"deleted_at": "2023-12-28T03:06:24.254Z"
}
],
"pagination": {
"page": 820994,
"prev": "string",
"next": "string",
"self": "string"
}
}
Contacts & Audiences

Fetch One Preference

This operation fetches a single Preference using its id.

Parameters

TypeScript
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

TypeScript
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*[]>
FetchOnePreference.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const preferenceId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.contactsAndAudiences.fetchOnePreference(preferenceId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "019da1ff-e78f-4097-b007-4f15471b5e6e",
"name": "string",
"description": "string",
"is_public": false,
"channels": [
{
"default_opt_in": false
}
],
"tags": {},
"created_at": "2022-08-26T15:17:21.807Z",
"updated_at": "2024-01-29T22:47:11.859Z",
"deleted_at": "2023-09-12T10:43:40.519Z"
}
Contacts & Audiences

Update One Preference

This operation updates a single Preference using its id.

Parameters

TypeScript
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

TypeScript
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*[]>
UpdateOnePreference.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { } from "Twilio-Communications-API/models";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const preferenceId = "01h9krwprkeee8fzqspvwy6nq8";
const requestBody = {
channels: [
CommunicationType.PushNotification,
],
tags: {
"key": {},
},
};

const result = await sdk.contactsAndAudiences.updateOnePreference(preferenceId, requestBody);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "9d488e1e-91e4-450a-92ab-d44269802d50",
"name": "string",
"description": "string",
"is_public": false,
"channels": [
{
"default_opt_in": false
}
],
"tags": {},
"created_at": "2024-01-13T21:17:10.500Z",
"updated_at": "2023-09-17T07:14:33.032Z",
"deleted_at": "2022-10-23T22:17:22.586Z"
}
Contacts & Audiences

Delete One Preference

This operation deletes a single Preference using its id.

Parameters

TypeScript
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

TypeScript
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*[]>
DeleteOnePreference.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const preferenceId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.contactsAndAudiences.deleteOnePreference(preferenceId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"code": 703737,
"message": "string",
"more_info": "https://flashy-void.info"
}
Contacts & Audiences

List Contact Preferences

This operation fetches a paginated list of Preferences

Parameters

TypeScript
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

TypeScript
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*[]>
ListContactPreferences.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const contactId = "01h9krwprkeee8fzqspvwy6nq8";
const isPublic = false;

const result = await sdk.contactsAndAudiences.listContactPreferences(contactId, isPublic);

// Handle the result
console.log(result)
}

run();
Example Response
{
"preferences": [
{
"id": "3c969e9a-3efa-477d-bb14-cd66ae395efb",
"preference": {
"id": "9ba88f3a-6699-4707-8ba4-469b6e214195",
"name": "string",
"description": "string",
"is_public": false,
"channels": [
{
"default_opt_in": false
}
],
"tags": {},
"created_at": "2023-08-28T18:58:29.186Z",
"updated_at": "2023-09-22T11:03:05.504Z",
"deleted_at": "2022-02-06T20:28:28.078Z"
},
"channels": [
{}
],
"created_at": "2023-12-16T16:55:28.304Z",
"updated_at": "2022-12-18T19:30:41.398Z",
"deleted_at": "2023-04-18T20:01:49.802Z"
}
],
"pagination": {
"page": 221262,
"prev": "string",
"next": "string",
"self": "string"
}
}
Contacts & Audiences

Fetch One Contact Preference

This operation fetches a single Contact Preference using its id.

Parameters

TypeScript
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

TypeScript
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*[]>
FetchOneContactPreference.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const contactId = "01h9krwprkeee8fzqspvwy6nq8";
const contactPreferenceId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.contactsAndAudiences.fetchOneContactPreference(contactId, contactPreferenceId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "e2516fe4-c8b7-411e-9b7f-d2ed028921cd",
"preference": {
"id": "dc692601-fb57-46b0-95f0-d30c5fbb2587",
"name": "string",
"description": "string",
"is_public": false,
"channels": [
{
"default_opt_in": false
}
],
"tags": {},
"created_at": "2023-01-07T12:39:52.211Z",
"updated_at": "2022-08-08T04:42:30.977Z",
"deleted_at": "2022-07-16T17:18:43.234Z"
},
"channels": [
{}
],
"created_at": "2024-05-19T21:25:27.717Z",
"updated_at": "2023-05-23T22:36:52.119Z",
"deleted_at": "2022-09-03T10:06:53.474Z"
}
Contacts & Audiences

Update One Contact Preference

This operation updates a single Contact Preference using its id.

Parameters

TypeScript
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

TypeScript
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*[]>
UpdateOneContactPreference.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const contactId = "01h9krwprkeee8fzqspvwy6nq8";
const contactPreferenceId = "01h9krwprkeee8fzqspvwy6nq8";
const requestBody = {
channels: [
{
channel: CommunicationType.Email,
status: PreferenceChannelStatus.DefaultedOptOut,
},
],
};

const result = await sdk.contactsAndAudiences.updateOneContactPreference(contactId, contactPreferenceId, requestBody);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "d5fe9b90-c289-409b-bfe4-9a8d9cbf4863",
"preference": {
"id": "3323f9b7-7f3a-4410-8674-ebf69280d1ba",
"name": "string",
"description": "string",
"is_public": false,
"channels": [
{
"default_opt_in": false
}
],
"tags": {},
"created_at": "2023-05-13T06:02:29.999Z",
"updated_at": "2024-01-13T01:57:13.620Z",
"deleted_at": "2023-08-12T02:10:46.219Z"
},
"channels": [
{}
],
"created_at": "2024-02-23T07:23:17.235Z",
"updated_at": "2024-12-21T09:52:32.288Z",
"deleted_at": "2023-05-30T13:39:14.475Z"
}
Contacts & Audiences

Create Audience

This operation creates an Audience

Parameters

TypeScript
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

TypeScript
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*[]>
CreateAudience.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.contactsAndAudiences.createAudience({
tags: {
"key": {},
},
});

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "audience_01h9krwprkeee8fzqspvwy6nq8",
"name": "string",
"contact_count": 216897,
"tags": {},
"created_at": "2023-05-15T19:00:31.154Z",
"updated_at": "2023-12-28T17:36:32.640Z",
"deleted_at": "2024-09-20T10:25:17.071Z"
}
Contacts & Audiences

List Audiences

This operation fetches a paginated list of Audiences.

Parameters

TypeScript
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

TypeScript
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*[]>
ListAudiences.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const startDate = new Date("2023-08-21T04:36:25.552Z");
const endDate = new Date("2024-07-17T14:06:34.909Z");

const result = await sdk.contactsAndAudiences.listAudiences(startDate, endDate);

// Handle the result
console.log(result)
}

run();
Example Response
{
"audiences": [
{
"id": "audience_01h9krwprkeee8fzqspvwy6nq8",
"name": "string",
"contact_count": 263322,
"tags": {},
"created_at": "2022-05-31T09:26:45.422Z",
"updated_at": "2022-01-23T15:12:14.503Z",
"deleted_at": "2022-09-09T05:23:06.262Z"
}
],
"pagination": {
"page": 758379,
"prev": "string",
"next": "string",
"self": "string"
}
}
Contacts & Audiences

Fetch Single Audience

This operation fetches a single Audience using its Id.

Parameters

TypeScript
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

TypeScript
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*[]>
FetchSingleAudience.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const audienceId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.contactsAndAudiences.fetchSingleAudience(audienceId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "audience_01h9krwprkeee8fzqspvwy6nq8",
"name": "string",
"contact_count": 881586,
"tags": {},
"created_at": "2022-12-17T17:43:51.515Z",
"updated_at": "2024-09-18T05:59:40.567Z",
"deleted_at": "2023-02-25T06:38:03.101Z"
}
Contacts & Audiences

Delete Audience

This operation deletes an Audience using its Id.

Parameters

TypeScript
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

TypeScript
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*[]>
DeleteAudience.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const audienceId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.contactsAndAudiences.deleteAudience(audienceId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"code": 645785,
"message": "string",
"more_info": "https://gaseous-spank.name"
}
Contacts & Audiences

Add Contact To Audience

This operation adds a Contact to an Audience

Parameters

TypeScript
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

TypeScript
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*[]>
AddContactToAudience.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const audienceId = "01h9krwprkeee8fzqspvwy6nq8";
const requestBody = {
contactId: "contact_01h9krwprkeee8fzqspvwy6nq8",
};

const result = await sdk.contactsAndAudiences.addContactToAudience(audienceId, requestBody);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "audience_01h9krwprkeee8fzqspvwy6nq8",
"name": "string",
"contact_count": 628982,
"tags": {},
"created_at": "2022-01-01T01:27:21.369Z",
"updated_at": "2024-08-14T10:12:10.426Z",
"deleted_at": "2022-12-08T19:10:16.465Z"
}
Contacts & Audiences

List Contacts In Audience

This operation fetches a paginated list of Contacts that belong to an Audience.

Parameters

TypeScript
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

TypeScript
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*[]>
ListContactsInAudience.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const audienceId = "01h9krwprkeee8fzqspvwy6nq8";
const startDate = new Date("2023-04-10T07:48:56.789Z");
const endDate = new Date("2023-11-15T10:13:10.092Z");

const result = await sdk.contactsAndAudiences.listContactsInAudience(audienceId, startDate, endDate);

// Handle the result
console.log(result)
}

run();
Example Response
{
"contacts": [
{
"first_name": "string",
"last_name": "string",
"display_name": "string",
"user_identifier": "string",
"location": {
"latitude": 2735.42,
"longitude": 4254.51,
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country_code": "string"
},
"date_of_birth": "string",
"national_id": "string",
"id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"addresses": [
{
"address": "string",
"is_validated_by_lookup": false,
"last_validated_by_lookup": "2024-08-28T07:55:18.917Z"
}
],
"audiences": [
{
"audience_id": "audience_01h9krwprkeee8fzqspvwy6nq8"
}
],
"tags": {},
"operation_id": "operation_01h9krwprkeee8fzqspvwy6nq8",
"created_at": "2022-07-23T10:58:04.259Z",
"updated_at": "2024-01-16T03:32:57.054Z"
}
],
"pagination": {
"page": 952792,
"prev": "string",
"next": "string",
"self": "string"
}
}
Contacts & Audiences

Remove Contact From Audience

This operation removes a Contact from an Audience

Parameters

TypeScript
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

TypeScript
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*[]>
RemoveContactFromAudience.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const audienceId = "01h9krwprkeee8fzqspvwy6nq8";
const contactId = "contact_01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.contactsAndAudiences.removeContactFromAudience(audienceId, contactId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"code": 456130,
"message": "string",
"more_info": "https://left-cousin.net"
}

Emails

*Use Emails to send and receive email with Twilio SendGrid.*

Available Operations

Emails

Send Emails

This operation creates and sends out emails to the specified recipients.

Parameters

TypeScript
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

TypeScript
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*[]>
SendEmails.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.emails.sendEmails({
to: [
,
],
replyTo: [
,
],
cc: [
,
],
bcc: [
,
],
tags: {
"key": {},
},
processingOptions: {
usePreference: {
preferenceId: "preference_01h9krwprkeee8fzqspvwy6nq8",
},
},
});

// Handle the result
console.log(result)
}

run();
Example Response
{
"emails": [
{
"id": "email_01h9krwprkeee8fzqspvwy6nq8",
"content": {
"subject": "string",
"text": "string",
"html": "string",
"default_variables": {},
"attachments": [
{
"id": "media_01h9krwprkeee8fzqspvwy6nq8",
"file_name": "string",
"file_size": 2294.42,
"mime_type": "text/plain",
"content_reference": {
"temporary_url": "https://unacceptable-destiny.biz",
"expires_at": "2022-08-22T18:57:29.475Z"
},
"tags": {},
"created_by": {
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8"
},
"updated_at": "2023-07-22T22:45:05.441Z",
"created_at": "2023-06-02T00:57:12.422Z",
"deleted_at": "2022-01-29T03:01:55.252Z"
}
]
},
"from": {
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
},
"to": [
{
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
}
],
"reply_to": [
{
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
}
],
"cc": [
{
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
}
],
"bcc": [
{
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
}
],
"delivery_status": {
"total_count": 711584,
"queued": {
"count": 207470
},
"sent": {
"count": 424685
},
"delivered": {
"count": 374170
},
"read": {
"count": 463575
},
"opened": {
"count": 277628
},
"undelivered": {
"count": 586784
},
"failed": {
"count": 863856
}
},
"related": [
{
"id": "string",
"uri": "string"
}
],
"tags": {},
"created_at": "2023-07-22T01:08:24.502Z",
"updated_at": "2022-10-31T11:24:47.724Z",
"deleted_at": "2022-05-25T17:55:10.407Z"
}
]
}
Emails

List Emails

This operation fetches a paginated list of Emails.

Parameters

TypeScript
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

TypeScript
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*[]>
ListEmails.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.emails.listEmails({
operationId: "operation_01h9krwprkeee8fzqspvwy6nq8",
conversationId: "conversation_01h9krwprkeee8fzqspvwy6nq8",
toContact: "contact_01h9krwprkeee8fzqspvwy6nq8",
});

// Handle the result
console.log(result)
}

run();
Example Response
{
"emails": [
{
"id": "email_01h9krwprkeee8fzqspvwy6nq8",
"content": {
"subject": "string",
"text": "string",
"html": "string",
"default_variables": {},
"attachments": [
{
"id": "media_01h9krwprkeee8fzqspvwy6nq8",
"file_name": "string",
"file_size": 7168.6,
"mime_type": "text/plain",
"content_reference": {
"temporary_url": "https://humming-innocent.name",
"expires_at": "2024-07-10T02:37:55.899Z"
},
"tags": {},
"created_by": {
"address": "string"
},
"updated_at": "2022-06-08T18:04:31.965Z",
"created_at": "2022-06-30T19:04:41.355Z",
"deleted_at": "2023-06-19T21:49:57.037Z"
}
]
},
"from": {
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
},
"to": [
{
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
}
],
"reply_to": [
{
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
}
],
"cc": [
{
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
}
],
"bcc": [
{
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
}
],
"delivery_status": {
"total_count": 124833,
"queued": {
"count": 355613
},
"sent": {
"count": 940432
},
"delivered": {
"count": 765326
},
"read": {
"count": 748664
},
"opened": {
"count": 903720
},
"undelivered": {
"count": 83422
},
"failed": {
"count": 552193
}
},
"related": [
{
"id": "string",
"uri": "string"
}
],
"tags": {},
"created_at": "2024-11-20T06:46:28.675Z",
"updated_at": "2022-08-18T05:39:59.272Z",
"deleted_at": "2022-11-17T04:38:55.132Z"
}
],
"pagination": {
"page": 286915,
"prev": "string",
"next": "string",
"self": "string"
}
}
Emails

Fetch One Email

This operation fetches a single Email using its id.

Parameters

TypeScript
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

TypeScript
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*[]>
FetchOneEmail.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const emailId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.emails.fetchOneEmail(emailId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "email_01h9krwprkeee8fzqspvwy6nq8",
"content": {
"subject": "string",
"text": "string",
"html": "string",
"default_variables": {},
"attachments": [
{
"id": "media_01h9krwprkeee8fzqspvwy6nq8",
"file_name": "string",
"file_size": 6772.63,
"mime_type": "text/plain",
"content_reference": {
"temporary_url": "http://basic-aim.name",
"expires_at": "2024-10-15T18:20:21.062Z"
},
"tags": {},
"created_by": {
"address": "string"
},
"updated_at": "2024-07-02T00:14:02.554Z",
"created_at": "2024-05-10T12:39:43.747Z",
"deleted_at": "2024-12-14T19:48:05.144Z"
}
]
},
"from": {
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
},
"to": [
{
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
}
],
"reply_to": [
{
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
}
],
"cc": [
{
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
}
],
"bcc": [
{
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
}
],
"delivery_status": {
"total_count": 281730,
"queued": {
"count": 703495
},
"sent": {
"count": 181631
},
"delivered": {
"count": 512393
},
"read": {
"count": 580447
},
"opened": {
"count": 787542
},
"undelivered": {
"count": 606476
},
"failed": {
"count": 218403
}
},
"related": [
{
"id": "string",
"uri": "string"
}
],
"tags": {},
"created_at": "2024-08-21T05:47:22.603Z",
"updated_at": "2024-11-06T10:52:56.237Z",
"deleted_at": "2023-06-24T12:37:25.611Z"
}
Emails

Delete Email

This operation deletes an Email

Parameters

TypeScript
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

TypeScript
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*[]>
DeleteEmail.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const emailId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.emails.deleteEmail(emailId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"code": 941378,
"message": "string",
"more_info": "https://starchy-kazoo.name"
}
Emails

List Email Operations

This operation fetches a paginated list of Email Operations.

Parameters

TypeScript
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
NameValue
processingprocessing
completedcompleted
canceledcanceled
failedfailed
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

TypeScript
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*[]>
ListEmailOperations.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { EmailOperationStatus } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const startDate = new Date("2023-12-09T21:35:55.692Z");
const endDate = new Date("2023-02-26T06:46:35.231Z");
const status = EmailOperationStatus.Completed;

const result = await sdk.emails.listEmailOperations(startDate, endDate, status);

// Handle the result
console.log(result)
}

run();
Example Response
{
"operations": [
{
"id": "operation_01h9krwprkeee8fzqspvwy6nq8",
"delivery": {
"total_count": 874288,
"queued": {
"count": 498140
},
"sent": {
"count": 844550
},
"delivered": {
"count": 194342
},
"read": {
"count": 773326
},
"opened": {
"count": 974259
},
"undelivered": {
"count": 862310
},
"failed": {
"count": 780427
}
},
"created_at": "2024-12-15T14:17:20.778Z",
"updated_at": "2023-06-09T07:03:09.156Z"
}
],
"pagination": {
"page": 753570,
"prev": "string",
"next": "string",
"self": "string"
}
}
Emails

Fetch One Email Operation

This operation fetches a single Email Operation using its id.

Parameters

TypeScript
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

TypeScript
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*[]>
FetchOneEmailOperation.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const operationId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.emails.fetchOneEmailOperation(operationId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "operation_01h9krwprkeee8fzqspvwy6nq8",
"delivery": {
"total_count": 4048,
"queued": {
"count": 639473
},
"sent": {
"count": 368584
},
"delivered": {
"count": 136900
},
"read": {
"count": 822118
},
"opened": {
"count": 189848
},
"undelivered": {
"count": 511319
},
"failed": {
"count": 224317
}
},
"created_at": "2022-04-18T05:42:04.906Z",
"updated_at": "2023-03-22T02:35:35.890Z"
}
Emails

Cancel Email Operation

This operation cancels an Email Operation using its id.

Parameters

TypeScript
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

TypeScript
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*[]>
CancelEmailOperation.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const operationId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.emails.cancelEmailOperation(operationId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "operation_01h9krwprkeee8fzqspvwy6nq8",
"delivery": {
"total_count": 569211,
"queued": {
"count": 972920
},
"sent": {
"count": 960835
},
"delivered": {
"count": 906556
},
"read": {
"count": 774048
},
"opened": {
"count": 333145
},
"undelivered": {
"count": 81101
},
"failed": {
"count": 407241
}
},
"created_at": "2022-09-12T12:41:12.694Z",
"updated_at": "2024-10-12T03:06:17.933Z"
}

Messages

*Use Messages to send and receive SMS & MMS, WhatsApp, Facebook Messenger, and Google Business messages.*

Available Operations

Messages

Send Messages

This operation creates and sends out messages to the specified recipients.

Parameters

TypeScript
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

TypeScript
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*[]>
SendMessages.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.messages.sendMessages({
to: [
,
],
processingOptions: {
domain: "domain_01h9krwprkeee8fzqspvwy6nq8",
usePreference: {
preferenceId: "preference_01h9krwprkeee8fzqspvwy6nq8",
},
},
tags: {
"key": {},
},
});

// Handle the result
console.log(result)
}

run();
Example Response
{
"messages": [
{
"id": "message_01h9krwprkeee8fzqspvwy6nq8",
"content": {
"text": "string",
"media": [
{
"id": "media_01h9krwprkeee8fzqspvwy6nq8",
"file_name": "string",
"file_size": 3253.1,
"mime_type": "text/plain",
"content_reference": {
"temporary_url": "http://weepy-reamer.com",
"expires_at": "2022-01-13T12:35:16.005Z"
},
"tags": {},
"created_by": {
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
},
"updated_at": "2024-04-24T13:21:21.659Z",
"created_at": "2022-11-30T19:43:32.608Z",
"deleted_at": "2022-06-11T01:17:04.060Z"
}
],
"location": {
"title": "string",
"latitude": 8828.6,
"longitude": 795.22
},
"list_picker": {
"text": "string",
"button_text": "string",
"list_items": [
{
"id": "string",
"title": "string",
"subtitle": "string"
}
]
},
"quick_reply": {
"text": "string",
"reply_items": [
{
"id": "string",
"title": "string"
}
]
},
"call_to_action": {
"text": "string",
"actions": [
{
"type": "url",
"title": "string",
"url": "string"
}
]
},
"card": {
"title": "string",
"subtitle": "string",
"actions": [
{
"type": "phone_number",
"title": "string",
"phone_number": "string"
}
]
}
},
"from": {
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
},
"to": [
{
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
}
],
"related": [
{
"id": "string",
"uri": "string"
}
],
"tags": {},
"delivery_status": {
"total_count": 245367,
"queued": {
"count": 432148
},
"sent": {
"count": 752135
},
"delivered": {
"count": 829603
},
"read": {
"count": 379034
},
"opened": {
"count": 96549
},
"undelivered": {
"count": 256139
},
"failed": {
"count": 591935
}
},
"created_at": "2023-06-07T05:15:22.936Z",
"updated_at": "2022-11-27T13:15:01.675Z",
"deleted_at": "2023-06-19T18:37:51.483Z"
}
]
}
Messages

List Messages

This operation fetches a paginated list of Messages.

Parameters

TypeScript
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

TypeScript
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*[]>
ListMessages.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { MessageChannel } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.messages.listMessages({
operationId: "operation_01h9krwprkeee8fzqspvwy6nq8",
conversationId: "conversation_01h9krwprkeee8fzqspvwy6nq8",
toContact: "01h9krwprkeee8fzqspvwy6nq8",
fromContact: "01h9krwprkeee8fzqspvwy6nq8",
channel: MessageChannel.Tel,
});

// Handle the result
console.log(result)
}

run();
Example Response
{
"operation": {
"id": "operation_01h9krwprkeee8fzqspvwy6nq8",
"delivery": {
"total_count": 262118,
"queued": {
"count": 458515
},
"sent": {
"count": 524593
},
"delivered": {
"count": 442015
},
"read": {
"count": 852635
},
"opened": {
"count": 433439
},
"undelivered": {
"count": 826871
},
"failed": {
"count": 509342
}
}
},
"messages": [
{
"id": "message_01h9krwprkeee8fzqspvwy6nq8",
"content": {
"text": "string",
"media": [
{
"id": "media_01h9krwprkeee8fzqspvwy6nq8",
"file_name": "string",
"file_size": 568.48,
"mime_type": "text/plain",
"content_reference": {
"temporary_url": "https://rewarding-copy.net",
"expires_at": "2024-07-17T14:43:47.752Z"
},
"tags": {},
"created_by": {
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8"
},
"updated_at": "2024-01-17T18:28:14.327Z",
"created_at": "2022-10-12T07:51:04.194Z",
"deleted_at": "2022-07-15T11:46:29.520Z"
}
],
"location": {
"title": "string",
"latitude": 3738.13,
"longitude": 698.59
},
"list_picker": {
"text": "string",
"button_text": "string",
"list_items": [
{
"id": "string",
"title": "string",
"subtitle": "string"
}
]
},
"quick_reply": {
"text": "string",
"reply_items": [
{
"id": "string",
"title": "string"
}
]
},
"call_to_action": {
"text": "string",
"actions": [
{
"type": "phone_number",
"title": "string",
"phone_number": "string"
}
]
},
"card": {
"title": "string",
"subtitle": "string",
"actions": [
{
"type": "url",
"title": "string",
"url": "string"
}
]
}
},
"from": {
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
},
"to": [
{
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
}
],
"related": [
{
"id": "string",
"uri": "string"
}
],
"tags": {},
"delivery_status": {
"total_count": 133465,
"queued": {
"count": 197054
},
"sent": {
"count": 459856
},
"delivered": {
"count": 44612
},
"read": {
"count": 799796
},
"opened": {
"count": 76956
},
"undelivered": {
"count": 518835
},
"failed": {
"count": 306810
}
},
"created_at": "2023-09-25T23:41:23.030Z",
"updated_at": "2023-03-31T08:46:58.589Z",
"deleted_at": "2024-11-17T12:56:04.847Z"
}
],
"pagination": {
"page": 174112,
"prev": "string",
"next": "string",
"self": "string"
}
}
Messages

Fetch One Message

This operation fetches a single Message using its id.

Parameters

TypeScript
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

TypeScript
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*[]>
FetchOneMessage.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const messageId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.messages.fetchOneMessage(messageId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "message_01h9krwprkeee8fzqspvwy6nq8",
"content": {
"text": "string",
"media": [
{
"id": "media_01h9krwprkeee8fzqspvwy6nq8",
"file_name": "string",
"file_size": 4752.89,
"mime_type": "text/plain",
"content_reference": {
"temporary_url": "http://sparkling-hog.name",
"expires_at": "2023-07-13T23:28:59.906Z"
},
"tags": {},
"created_by": {
"address": "string"
},
"updated_at": "2022-06-07T15:17:15.644Z",
"created_at": "2024-01-17T19:20:55.093Z",
"deleted_at": "2023-12-13T19:28:32.107Z"
}
],
"location": {
"title": "string",
"latitude": 2775.96,
"longitude": 5392.24
},
"list_picker": {
"text": "string",
"button_text": "string",
"list_items": [
{
"id": "string",
"title": "string",
"subtitle": "string"
}
]
},
"quick_reply": {
"text": "string",
"reply_items": [
{
"id": "string",
"title": "string"
}
]
},
"call_to_action": {
"text": "string",
"actions": [
{
"type": "url",
"title": "string",
"url": "string"
}
]
},
"card": {
"title": "string",
"subtitle": "string",
"actions": [
{
"type": "url",
"title": "string",
"url": "string"
}
]
}
},
"from": {
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
},
"to": [
{
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
}
],
"related": [
{
"id": "string",
"uri": "string"
}
],
"tags": {},
"delivery_status": {
"total_count": 159870,
"queued": {
"count": 187131
},
"sent": {
"count": 903984
},
"delivered": {
"count": 543806
},
"read": {
"count": 456911
},
"opened": {
"count": 882042
},
"undelivered": {
"count": 458604
},
"failed": {
"count": 724168
}
},
"created_at": "2023-03-14T07:57:43.931Z",
"updated_at": "2022-04-13T10:21:26.999Z",
"deleted_at": "2024-09-17T19:59:01.544Z"
}
Messages

Delete Message

This operation deletes a Message

Parameters

TypeScript
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

TypeScript
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*[]>
DeleteMessage.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const messageId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.messages.deleteMessage(messageId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"code": 426306,
"message": "string",
"more_info": "https://kooky-propaganda.name"
}
Messages

List Message Operations

This operation fetches a paginated list of Message Operations.

Parameters

TypeScript
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
NameValue
processingprocessing
completedcompleted
canceledcanceled
failedfailed
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

TypeScript
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*[]>
ListMessageOperations.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { MessageOperationStatus } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const startDate = new Date("2022-11-23T02:21:00.924Z");
const endDate = new Date("2024-09-04T09:11:49.338Z");
const status = MessageOperationStatus.Processing;

const result = await sdk.messages.listMessageOperations(startDate, endDate, status);

// Handle the result
console.log(result)
}

run();
Example Response
{
"operations": [
{
"id": "operation_01h9krwprkeee8fzqspvwy6nq8",
"delivery": {
"total_count": 716244,
"queued": {
"count": 756779
},
"sent": {
"count": 636061
},
"delivered": {
"count": 240020
},
"read": {
"count": 160538
},
"opened": {
"count": 796392
},
"undelivered": {
"count": 959167
},
"failed": {
"count": 458139
}
},
"created_at": "2023-10-10T17:14:50.735Z",
"updated_at": "2024-11-11T06:41:13.966Z"
}
],
"pagination": {
"page": 857723,
"prev": "string",
"next": "string",
"self": "string"
}
}
Messages

Fetch One Message Operation

This operation fetches a single Message Operation using its id.

Parameters

TypeScript
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

TypeScript
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*[]>
FetchOneMessageOperation.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const operationId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.messages.fetchOneMessageOperation(operationId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "operation_01h9krwprkeee8fzqspvwy6nq8",
"delivery": {
"total_count": 457223,
"queued": {
"count": 97468
},
"sent": {
"count": 621679
},
"delivered": {
"count": 863023
},
"read": {
"count": 157632
},
"opened": {
"count": 992430
},
"undelivered": {
"count": 85001
},
"failed": {
"count": 94458
}
},
"created_at": "2023-11-26T10:25:18.758Z",
"updated_at": "2023-03-13T16:24:53.073Z"
}
Messages

Cancel Message Operation

This operation cancels a Message Operation using its id.

Parameters

TypeScript
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

TypeScript
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*[]>
CancelMessageOperation.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const operationId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.messages.cancelMessageOperation(operationId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "operation_01h9krwprkeee8fzqspvwy6nq8",
"delivery": {
"total_count": 62713,
"queued": {
"count": 936747
},
"sent": {
"count": 447378
},
"delivered": {
"count": 727697
},
"read": {
"count": 742238
},
"opened": {
"count": 306986
},
"undelivered": {
"count": 119771
},
"failed": {
"count": 443879
}
},
"created_at": "2023-03-06T09:13:54.436Z",
"updated_at": "2022-01-18T21:30:17.962Z"
}

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

Push Notifications

Send Push Notifications

This operation creates and sends out push notifications to the specified recipients.

Parameters

TypeScript
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

TypeScript
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*[]>
SendPushNotifications.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { PushNotificationPriority } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.pushNotifications.sendPushNotifications({
to: [
,
],
processingOptions: {
recipientPreferenceManagement: {},
},
tags: {
"key": {},
},
});

// Handle the result
console.log(result)
}

run();
Example Response
{
"push_notifications": [
{
"id": "pushnotification_01h9krwprkeee8fzqspvwy6nq8",
"to": [
{
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8"
}
],
"content": {
"title": "string",
"text": "string",
"click_action": {
"url": "http://terrific-grief.name",
"activity": "string"
},
"channel_passthrough": [
{
"data": {}
}
],
"icon": "string",
"default_variables": {},
"media": {
"id": "media_01h9krwprkeee8fzqspvwy6nq8",
"file_name": "string",
"file_size": 996.15,
"mime_type": "text/plain",
"content_reference": {
"temporary_url": "https://watchful-boudoir.org",
"expires_at": "2022-04-11T20:41:36.792Z"
},
"tags": {},
"created_by": {
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
},
"updated_at": "2022-03-03T08:07:30.724Z",
"created_at": "2022-12-25T01:32:24.446Z",
"deleted_at": "2022-04-05T20:09:02.208Z"
}
},
"sound": "string",
"time_to_deliver": "2023-09-03T22:35:07Z",
"related": [
{
"id": "string",
"uri": "string"
}
],
"tags": {},
"delivery_status": {
"total_count": 33074,
"queued": {
"count": 522371
},
"sent": {
"count": 513075
},
"delivered": {
"count": 649832
},
"read": {
"count": 544591
},
"opened": {
"count": 32465
},
"undelivered": {
"count": 580152
},
"failed": {
"count": 771089
}
},
"created_at": "2023-02-17T08:15:50.390Z",
"updated_at": "2022-01-14T04:36:02.933Z",
"deleted_at": "2023-06-23T03:54:53.209Z"
}
]
}
Push Notifications

List Push Notifications

This operation fetches a paginated list of Push Notifications.

Parameters

TypeScript
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

TypeScript
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*[]>
ListPushNotifications.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { PushNotificationChannel } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.pushNotifications.listPushNotifications({
operationId: "operation_01h9krwprkeee8fzqspvwy6nq8",
conversationId: "conversation_01h9krwprkeee8fzqspvwy6nq8",
toContact: "contact_01h9krwprkeee8fzqspvwy6nq8",
});

// Handle the result
console.log(result)
}

run();
Example Response
{
"push_notifications": [
{
"id": "pushnotification_01h9krwprkeee8fzqspvwy6nq8",
"to": [
{
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8"
}
],
"content": {
"title": "string",
"text": "string",
"click_action": {
"url": "https://personal-decongestant.org",
"activity": "string"
},
"channel_passthrough": [
{
"data": {}
}
],
"icon": "string",
"default_variables": {},
"media": {
"id": "media_01h9krwprkeee8fzqspvwy6nq8",
"file_name": "string",
"file_size": 456.59,
"mime_type": "text/plain",
"content_reference": {
"temporary_url": "http://friendly-circumstance.net",
"expires_at": "2023-12-02T01:59:21.096Z"
},
"tags": {},
"created_by": {
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8"
},
"updated_at": "2023-06-22T08:59:30.267Z",
"created_at": "2023-12-03T11:11:43.357Z",
"deleted_at": "2024-12-20T09:26:04.977Z"
}
},
"sound": "string",
"time_to_deliver": "PT10M",
"related": [
{
"id": "string",
"uri": "string"
}
],
"tags": {},
"delivery_status": {
"total_count": 801836,
"queued": {
"count": 288398
},
"sent": {
"count": 241418
},
"delivered": {
"count": 662505
},
"read": {
"count": 246063
},
"opened": {
"count": 665859
},
"undelivered": {
"count": 517309
},
"failed": {
"count": 424089
}
},
"created_at": "2023-08-31T22:30:29.478Z",
"updated_at": "2023-04-14T21:45:20.196Z",
"deleted_at": "2022-11-11T14:36:11.419Z"
}
],
"pagination": {
"page": 822560,
"prev": "string",
"next": "string",
"self": "string"
}
}
Push Notifications

Fetch One Push Notification

This operation fetches a single Push Notification using its id.

Parameters

TypeScript
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

TypeScript
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*[]>
FetchOnePushNotification.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const pushNotificationId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.pushNotifications.fetchOnePushNotification(pushNotificationId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "pushnotification_01h9krwprkeee8fzqspvwy6nq8",
"to": [
{
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8"
}
],
"content": {
"title": "string",
"text": "string",
"click_action": {
"url": "https://immense-icing.info",
"activity": "string"
},
"channel_passthrough": [
{
"data": {}
}
],
"icon": "string",
"default_variables": {},
"media": {
"id": "media_01h9krwprkeee8fzqspvwy6nq8",
"file_name": "string",
"file_size": 3631.61,
"mime_type": "text/plain",
"content_reference": {
"temporary_url": "https://hungry-aspect.net",
"expires_at": "2022-09-12T23:01:13.303Z"
},
"tags": {},
"created_by": {
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
},
"updated_at": "2023-01-17T23:27:12.009Z",
"created_at": "2024-10-24T06:19:40.469Z",
"deleted_at": "2024-06-12T04:52:41.978Z"
}
},
"sound": "string",
"time_to_deliver": 600,
"related": [
{
"id": "string",
"uri": "string"
}
],
"tags": {},
"delivery_status": {
"total_count": 968972,
"queued": {
"count": 697142
},
"sent": {
"count": 897071
},
"delivered": {
"count": 121059
},
"read": {
"count": 241545
},
"opened": {
"count": 228263
},
"undelivered": {
"count": 489509
},
"failed": {
"count": 891523
}
},
"created_at": "2023-01-28T11:39:32.490Z",
"updated_at": "2024-01-26T23:39:52.038Z",
"deleted_at": "2023-02-27T05:17:06.651Z"
}
Push Notifications

Delete Push Notification

This operation deletes a Push Notification

Parameters

TypeScript
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

TypeScript
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*[]>
DeletePushNotification.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const pushNotificationId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.pushNotifications.deletePushNotification(pushNotificationId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"code": 58356,
"message": "string",
"more_info": "https://self-assured-bull.org"
}
Push Notifications

List Push Notification Operations

This operation fetches a paginated list of Push Notification Operations.

Parameters

TypeScript
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
NameValue
processingprocessing
completedcompleted
canceledcanceled
failedfailed
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

TypeScript
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*[]>
ListPushNotificationOperations.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { PushNotificationOperationStatus } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const startDate = new Date("2024-11-22T04:11:07.245Z");
const endDate = new Date("2022-10-26T19:57:04.215Z");
const status = PushNotificationOperationStatus.Completed;

const result = await sdk.pushNotifications.listPushNotificationOperations(startDate, endDate, status);

// Handle the result
console.log(result)
}

run();
Example Response
{
"operations": [
{
"id": "operation_01h9krwprkeee8fzqspvwy6nq8",
"delivery": {
"total_count": 272437,
"queued": {
"count": 132815
},
"sent": {
"count": 374244
},
"delivered": {
"count": 324405
},
"read": {
"count": 680116
},
"opened": {
"count": 795535
},
"undelivered": {
"count": 503934
},
"failed": {
"count": 296242
}
},
"created_at": "2024-08-29T00:21:05.159Z",
"updated_at": "2024-07-08T18:01:50.281Z"
}
],
"pagination": {
"page": 351870,
"prev": "string",
"next": "string",
"self": "string"
}
}
Push Notifications

Fetch One Push Notification Operation

This operation fetches a single Push Notification Operation using its id.

Parameters

TypeScript
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

TypeScript
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*[]>
FetchOnePushNotificationOperation.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const operationId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.pushNotifications.fetchOnePushNotificationOperation(operationId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "operation_01h9krwprkeee8fzqspvwy6nq8",
"delivery": {
"total_count": 738391,
"queued": {
"count": 502389
},
"sent": {
"count": 942584
},
"delivered": {
"count": 633998
},
"read": {
"count": 867290
},
"opened": {
"count": 940210
},
"undelivered": {
"count": 750765
},
"failed": {
"count": 699575
}
},
"created_at": "2024-11-26T21:21:58.965Z",
"updated_at": "2022-05-25T12:14:09.382Z"
}
Push Notifications

Cancel Push Notification Operation

This operation cancels a Push Notification Operation using its id.

Parameters

TypeScript
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

TypeScript
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*[]>
CancelPushNotificationOperation.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const operationId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.pushNotifications.cancelPushNotificationOperation(operationId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "operation_01h9krwprkeee8fzqspvwy6nq8",
"delivery": {
"total_count": 707918,
"queued": {
"count": 451822
},
"sent": {
"count": 70869
},
"delivered": {
"count": 292794
},
"read": {
"count": 152354
},
"opened": {
"count": 417486
},
"undelivered": {
"count": 131289
},
"failed": {
"count": 604118
}
},
"created_at": "2023-02-24T13:22:59.417Z",
"updated_at": "2024-11-18T10:35:39.874Z"
}

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

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

TypeScript
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

TypeScript
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*[]>
SendCommunications.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { PushNotificationPriority } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.communications.sendCommunications({
to: [
,
],
processingOptions: {
usePreference: {},
messages: {},
emails: {
replyTo: [
,
],
cc: [
,
],
bcc: [
,
],
},
pushNotifications: {},
},
tags: {
"key": {},
},
});

// Handle the result
console.log(result)
}

run();
Example Response
{
"communications": [
{
"id": "communication_01h9krwprkeee8fzqspvwy6nq8",
"from": {
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
},
"to": [
{
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
}
],
"content": {
"text": "string",
"html": "string",
"title": "string",
"media": [
{
"id": "media_01h9krwprkeee8fzqspvwy6nq8",
"file_name": "string",
"file_size": 193,
"mime_type": "text/plain",
"content_reference": {
"temporary_url": "https://wooden-documentary.com",
"expires_at": "2023-10-12T02:01:44.094Z"
},
"tags": {},
"created_by": {
"address": "string"
},
"updated_at": "2022-08-25T05:16:11.780Z",
"created_at": "2023-03-22T18:42:49.757Z",
"deleted_at": "2023-09-28T14:00:56.803Z"
}
],
"location": {
"title": "string",
"latitude": 5520.78,
"longitude": 9757.52
},
"list_picker": {
"text": "string",
"button_text": "string",
"list_items": [
{
"id": "string",
"title": "string",
"subtitle": "string"
}
]
},
"quick_reply": {
"text": "string",
"reply_items": [
{
"id": "string",
"title": "string"
}
]
},
"call_to_action": {
"text": "string",
"actions": [
{
"type": "url",
"title": "string",
"url": "string"
}
]
},
"card": {
"title": "string",
"subtitle": "string",
"actions": [
{
"type": "url",
"title": "string",
"url": "string"
}
]
}
},
"delivery_status": {
"total_count": 970076,
"queued": {
"count": 401713
},
"sent": {
"count": 248413
},
"delivered": {
"count": 505866
},
"read": {
"count": 310381
},
"opened": {
"count": 373035
},
"undelivered": {
"count": 524970
},
"failed": {
"count": 750595
}
},
"related": [
{
"id": "string",
"uri": "string"
}
],
"tags": {},
"created_at": "2024-10-09T21:04:19.713Z",
"updated_at": "2024-11-25T23:09:14.590Z",
"deleted_at": "2024-08-03T02:25:37.503Z"
}
]
}
Communications

List Communications

This operation fetches a paginated list of Communications.

Parameters

TypeScript
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

TypeScript
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*[]>
ListCommunications.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { CommunicationChannel, CommunicationType } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.communications.listCommunications({
operationId: "operation_01h9krwprkeee8fzqspvwy6nq8",
conversationId: "conversation_01h9krwprkeee8fzqspvwy6nq8",
toContact: "contact_01h9krwprkeee8fzqspvwy6nq8",
});

// Handle the result
console.log(result)
}

run();
Example Response
{
"communications": [
{
"id": "communication_01h9krwprkeee8fzqspvwy6nq8",
"from": {
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
},
"to": [
{
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
}
],
"content": {
"text": "string",
"html": "string",
"title": "string",
"media": [
{
"id": "media_01h9krwprkeee8fzqspvwy6nq8",
"file_name": "string",
"file_size": 2536.42,
"mime_type": "text/plain",
"content_reference": {
"temporary_url": "http://international-tax.com",
"expires_at": "2023-07-16T15:31:42.506Z"
},
"tags": {},
"created_by": {
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
},
"updated_at": "2023-07-14T15:34:57.575Z",
"created_at": "2024-03-22T03:31:31.298Z",
"deleted_at": "2023-02-28T23:06:04.973Z"
}
],
"location": {
"title": "string",
"latitude": 6805.15,
"longitude": 5300.89
},
"list_picker": {
"text": "string",
"button_text": "string",
"list_items": [
{
"id": "string",
"title": "string",
"subtitle": "string"
}
]
},
"quick_reply": {
"text": "string",
"reply_items": [
{
"id": "string",
"title": "string"
}
]
},
"call_to_action": {
"text": "string",
"actions": [
{
"type": "phone_number",
"title": "string",
"phone_number": "string"
}
]
},
"card": {
"title": "string",
"text": "string",
"footer": "string",
"actions": [
{
"type": "phone_number",
"title": "string",
"phone_number": "string"
}
]
}
},
"delivery_status": {
"total_count": 892863,
"queued": {
"count": 204923
},
"sent": {
"count": 341698
},
"delivered": {
"count": 676243
},
"read": {
"count": 879235
},
"opened": {
"count": 543678
},
"undelivered": {
"count": 282699
},
"failed": {
"count": 30235
}
},
"related": [
{
"id": "string",
"uri": "string"
}
],
"tags": {},
"created_at": "2022-01-09T15:23:00.369Z",
"updated_at": "2023-05-20T09:37:09.099Z",
"deleted_at": "2023-02-13T10:57:01.355Z"
}
],
"pagination": {
"page": 24527,
"prev": "string",
"next": "string",
"self": "string"
}
}
Communications

Fetch Single Communication

This operation fetches a single Communication using its Id.

Parameters

TypeScript
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

TypeScript
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*[]>
FetchSingleCommunication.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const communicationId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.communications.fetchSingleCommunication(communicationId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "communication_01h9krwprkeee8fzqspvwy6nq8",
"from": {
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
},
"to": [
{
"address": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
}
],
"content": {
"text": "string",
"html": "string",
"title": "string",
"media": [
{
"id": "media_01h9krwprkeee8fzqspvwy6nq8",
"file_name": "string",
"file_size": 3611.51,
"mime_type": "text/plain",
"content_reference": {
"temporary_url": "http://lovable-gumshoe.com",
"expires_at": "2022-01-27T15:32:03.734Z"
},
"tags": {},
"created_by": {
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
},
"updated_at": "2023-01-11T12:02:21.397Z",
"created_at": "2024-09-20T03:56:38.766Z",
"deleted_at": "2023-11-13T23:09:57.015Z"
}
],
"location": {
"title": "string",
"latitude": 85.11,
"longitude": 2790.68
},
"list_picker": {
"text": "string",
"button_text": "string",
"list_items": [
{
"id": "string",
"title": "string",
"subtitle": "string"
}
]
},
"quick_reply": {
"text": "string",
"reply_items": [
{
"id": "string",
"title": "string"
}
]
},
"call_to_action": {
"text": "string",
"actions": [
{
"type": "phone_number",
"title": "string",
"phone_number": "string"
}
]
},
"card": {
"title": "string",
"subtitle": "string",
"actions": [
{
"type": "phone_number",
"title": "string",
"phone_number": "string"
}
]
}
},
"delivery_status": {
"total_count": 115703,
"queued": {
"count": 99416
},
"sent": {
"count": 289776
},
"delivered": {
"count": 539074
},
"read": {
"count": 724148
},
"opened": {
"count": 388867
},
"undelivered": {
"count": 227084
},
"failed": {
"count": 454860
}
},
"related": [
{
"id": "string",
"uri": "string"
}
],
"tags": {},
"created_at": "2024-07-02T20:45:17.382Z",
"updated_at": "2024-11-21T04:42:37.240Z",
"deleted_at": "2024-09-29T14:39:13.019Z"
}
Communications

Delete Communication

This operation deletes a Communication

Parameters

TypeScript
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

TypeScript
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*[]>
DeleteCommunication.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const communicationId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.communications.deleteCommunication(communicationId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"code": 16871,
"message": "string",
"more_info": "https://revolving-humidity.net"
}
Communications

List Communication Operations

This operation fetches a paginated list of Communication Operations.

Parameters

TypeScript
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
NameValue
processingprocessing
completedcompleted
canceledcanceled
failedfailed
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

TypeScript
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*[]>
ListCommunicationOperations.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { CommunicationOperationStatus } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const startDate = new Date("2023-06-08T12:30:11.149Z");
const endDate = new Date("2024-05-17T17:32:07.006Z");
const status = CommunicationOperationStatus.Failed;

const result = await sdk.communications.listCommunicationOperations(startDate, endDate, status);

// Handle the result
console.log(result)
}

run();
Example Response
{
"operations": [
{
"id": "operation_01h9krwprkeee8fzqspvwy6nq8",
"delivery": {
"total_count": 509807,
"queued": {
"count": 648598
},
"sent": {
"count": 29100
},
"delivered": {
"count": 919532
},
"read": {
"count": 542457
},
"opened": {
"count": 991142
},
"undelivered": {
"count": 383103
},
"failed": {
"count": 806670
}
},
"created_at": "2023-05-21T06:19:25.029Z",
"updated_at": "2022-09-07T14:59:09.178Z"
}
],
"pagination": {
"page": 826825,
"prev": "string",
"next": "string",
"self": "string"
}
}
Communications

Fetch One Communication Operation

This operation fetches a single Communication Operation using its id.

Parameters

TypeScript
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

TypeScript
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*[]>
FetchOneCommunicationOperation.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const operationId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.communications.fetchOneCommunicationOperation(operationId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "operation_01h9krwprkeee8fzqspvwy6nq8",
"delivery": {
"total_count": 539118,
"queued": {
"count": 623295
},
"sent": {
"count": 886961
},
"delivered": {
"count": 618826
},
"read": {
"count": 133461
},
"opened": {
"count": 980581
},
"undelivered": {
"count": 871786
},
"failed": {
"count": 502721
}
},
"created_at": "2024-10-07T21:26:28.566Z",
"updated_at": "2023-08-18T04:10:23.565Z"
}
Communications

Cancel Communication Operation

This operation cancels an Communication Operation using its Id.

Parameters

TypeScript
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

TypeScript
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*[]>
CancelCommunicationOperation.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const operationId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.communications.cancelCommunicationOperation(operationId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "operation_01h9krwprkeee8fzqspvwy6nq8",
"delivery": {
"total_count": 120919,
"queued": {
"count": 923306
},
"sent": {
"count": 829898
},
"delivered": {
"count": 968287
},
"read": {
"count": 919783
},
"opened": {
"count": 36033
},
"undelivered": {
"count": 174772
},
"failed": {
"count": 389135
}
},
"created_at": "2024-11-09T13:09:41.589Z",
"updated_at": "2023-09-09T19:26:50.272Z"
}

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

Agents & Agent Pools

Create Agent

This operation creates an Agent.

Parameters

TypeScript
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

TypeScript
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*[]>
CreateAgent.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { CommunicationChannel } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.agentsAndAgentPools.createAgent({
id: "agent_01h9krwprkeee8fzqspvwy6nq8",
address: "4539 Bernier Green",
channel: CommunicationChannel.Email,
tags: {
"key": {},
},
});

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "agent_01h9krwprkeee8fzqspvwy6nq8",
"display_name": "string",
"first_name": "string",
"last_name": "string",
"address": "string",
"tags": {},
"updated_at": "2024-09-20T08:44:30.297Z",
"created_at": "2022-06-25T20:56:27.178Z",
"deleted_at": "2023-09-28T19:07:55.588Z"
}
Agents & Agent Pools

List Agents

This operation fetches a paginated list of Agents.

Parameters

TypeScript
channel?: components.CommunicationChannel

Filter to Representatives that match a specific channel.

Show child properties
NameValue
emailemail
teltel
whatsappwhatsapp
fbmfbm
gbmgbm
chatchat
apnapn
fcmfcm
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

TypeScript
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*[]>
ListAgents.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { CommunicationChannel } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const channel = CommunicationChannel.Chat;
const startDate = new Date("2022-01-23T03:49:29.173Z");
const endDate = new Date("2023-02-08T14:13:31.435Z");

const result = await sdk.agentsAndAgentPools.listAgents(channel, startDate, endDate);

// Handle the result
console.log(result)
}

run();
Example Response
{
"agents": [
{
"id": "agent_01h9krwprkeee8fzqspvwy6nq8",
"display_name": "string",
"first_name": "string",
"last_name": "string",
"address": "string",
"tags": {},
"updated_at": "2023-10-18T08:07:39.633Z",
"created_at": "2023-05-05T05:57:31.258Z",
"deleted_at": "2022-09-18T21:29:48.357Z"
}
],
"pagination": {
"page": 907876,
"prev": "string",
"next": "string",
"self": "string"
}
}
Agents & Agent Pools

Fetch One Agent

This operation fetches a single Agent using its id.

Parameters

TypeScript
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

TypeScript
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*[]>
FetchOneAgent.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const agentId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.agentsAndAgentPools.fetchOneAgent(agentId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "agent_01h9krwprkeee8fzqspvwy6nq8",
"display_name": "string",
"first_name": "string",
"last_name": "string",
"address": "string",
"tags": {},
"updated_at": "2022-06-25T14:42:08.428Z",
"created_at": "2022-06-09T20:58:06.757Z",
"deleted_at": "2023-12-26T14:02:06.440Z"
}
Agents & Agent Pools

Update Agent

This operation partially updates an Agent

Parameters

TypeScript
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

TypeScript
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*[]>
UpdateAgent.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { CommunicationChannel } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const agentId = "01h9krwprkeee8fzqspvwy6nq8";
const requestBody = {
tags: {
"key": {},
},
};

const result = await sdk.agentsAndAgentPools.updateAgent(agentId, requestBody);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "agent_01h9krwprkeee8fzqspvwy6nq8",
"display_name": "string",
"first_name": "string",
"last_name": "string",
"address": "string",
"tags": {},
"updated_at": "2023-04-28T12:41:51.629Z",
"created_at": "2023-11-17T13:53:16.489Z",
"deleted_at": "2022-03-25T19:54:28.931Z"
}
Agents & Agent Pools

Delete Agent

This operation deletes an Agent

Parameters

TypeScript
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

TypeScript
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*[]>
DeleteAgent.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const agentId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.agentsAndAgentPools.deleteAgent(agentId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"code": 361306,
"message": "string",
"more_info": "https://unwitting-degree.org"
}
Agents & Agent Pools

Create Agent Pool

This operation creates an AgentPool

Parameters

TypeScript
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

TypeScript
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*[]>
CreateAgentPool.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.agentsAndAgentPools.createAgentPool({
tags: {
"key": {},
},
geomatch: {},
channelRank: [
{},
],
});

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "agentpool_01h9krwprkeee8fzqspvwy6nq8",
"friendly_name": "string",
"agent_count": 39615,
"tags": {},
"created_at": "2023-04-21T20:01:42.100Z",
"updated_at": "2022-03-07T16:46:29.387Z",
"deleted_at": "2023-07-22T07:16:07.451Z",
"sticky_sender_enabled": false,
"geomatch": {
"country_code_enabled": false,
"area_code_enabled": false
},
"channel_rank": [
{
"rank": 61078
}
]
}
Agents & Agent Pools

List Agent Pools

This operation fetches a paginated list of AgentPools.

Parameters

TypeScript
channel?: components.CommunicationChannel

Filter to AgentPools that match a specific channel.

Show child properties
NameValue
emailemail
teltel
whatsappwhatsapp
fbmfbm
gbmgbm
chatchat
apnapn
fcmfcm
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

TypeScript
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*[]>
ListAgentPools.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { CommunicationChannel } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const channel = CommunicationChannel.Apn;
const startDate = new Date("2024-11-15T01:00:33.046Z");
const endDate = new Date("2024-05-02T20:38:07.200Z");

const result = await sdk.agentsAndAgentPools.listAgentPools(channel, startDate, endDate);

// Handle the result
console.log(result)
}

run();
Example Response
{
"agent_pools": [
{
"id": "agentpool_01h9krwprkeee8fzqspvwy6nq8",
"friendly_name": "string",
"agent_count": 907733,
"tags": {},
"created_at": "2022-07-22T01:28:25.533Z",
"updated_at": "2024-03-21T21:54:23.935Z",
"deleted_at": "2023-04-22T11:56:37.763Z",
"sticky_sender_enabled": false,
"geomatch": {
"country_code_enabled": false,
"area_code_enabled": false
},
"channel_rank": [
{
"rank": 898063
}
]
}
],
"pagination": {
"page": 672582,
"prev": "string",
"next": "string",
"self": "string"
}
}
Agents & Agent Pools

Fetch One Agent Pool

This operation fetches a single AgentPool using its id.

Parameters

TypeScript
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

TypeScript
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*[]>
FetchOneAgentPool.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const agentPoolId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.agentsAndAgentPools.fetchOneAgentPool(agentPoolId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "agentpool_01h9krwprkeee8fzqspvwy6nq8",
"friendly_name": "string",
"agent_count": 715208,
"tags": {},
"created_at": "2023-08-03T17:14:09.133Z",
"updated_at": "2023-07-28T05:09:36.614Z",
"deleted_at": "2022-11-30T16:09:25.930Z",
"sticky_sender_enabled": false,
"geomatch": {
"country_code_enabled": false,
"area_code_enabled": false
},
"channel_rank": [
{
"rank": 320565
}
]
}
Agents & Agent Pools

Update Agent Pool

This operation partially updates an AgentPool

Parameters

TypeScript
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

TypeScript
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*[]>
UpdateAgentPool.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const agentPoolId = "01h9krwprkeee8fzqspvwy6nq8";
const requestBody = {
tags: {
"key": {},
},
};

const result = await sdk.agentsAndAgentPools.updateAgentPool(agentPoolId, requestBody);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "agentpool_01h9krwprkeee8fzqspvwy6nq8",
"friendly_name": "string",
"agent_count": 3099,
"tags": {},
"created_at": "2023-02-01T23:01:15.488Z",
"updated_at": "2023-10-17T15:27:23.255Z",
"deleted_at": "2023-05-31T19:56:59.817Z",
"sticky_sender_enabled": false,
"geomatch": {
"country_code_enabled": false,
"area_code_enabled": false
},
"channel_rank": [
{
"rank": 649078
}
]
}
Agents & Agent Pools

Delete Agent Pool

This operation deletes an AgentPool

Parameters

TypeScript
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

TypeScript
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*[]>
DeleteAgentPool.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const agentPoolId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.agentsAndAgentPools.deleteAgentPool(agentPoolId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"code": 5189,
"message": "string",
"more_info": "https://wild-coaster.name"
}
Agents & Agent Pools

Add Agent To Agent Pool

This operation adds an Agent to an AgentPool

Parameters

TypeScript
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

TypeScript
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*[]>
AddAgentToAgentPool.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const agentPoolId = "01h9krwprkeee8fzqspvwy6nq8";
const requestBody = {
agentId: "agent_01h9krwprkeee8fzqspvwy6nq8",
};

const result = await sdk.agentsAndAgentPools.addAgentToAgentPool(agentPoolId, requestBody);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "agentpool_01h9krwprkeee8fzqspvwy6nq8",
"friendly_name": "string",
"agent_count": 327988,
"tags": {},
"created_at": "2022-11-18T06:52:13.468Z",
"updated_at": "2024-01-16T15:53:29.217Z",
"deleted_at": "2022-08-08T14:22:59.313Z",
"sticky_sender_enabled": false,
"geomatch": {
"country_code_enabled": false,
"area_code_enabled": false
},
"channel_rank": [
{
"rank": 63207
}
]
}
Agents & Agent Pools

List Agents In Agent Pool

This operation fetches a paginated list of Agents that belong to a AgentPool.

Parameters

TypeScript
agentPoolId: string

Example: [object Object]

channel?: components.CommunicationChannel

Filter to Agents that match a specific channel.

Show child properties
NameValue
emailemail
teltel
whatsappwhatsapp
fbmfbm
gbmgbm
chatchat
apnapn
fcmfcm
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

TypeScript
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*[]>
ListAgentsInAgentPool.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { CommunicationChannel } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const agentPoolId = "01h9krwprkeee8fzqspvwy6nq8";
const channel = CommunicationChannel.Tel;
const startDate = new Date("2024-08-11T12:47:58.088Z");
const endDate = new Date("2024-08-11T14:46:30.188Z");

const result = await sdk.agentsAndAgentPools.listAgentsInAgentPool(agentPoolId, channel, startDate, endDate);

// Handle the result
console.log(result)
}

run();
Example Response
{
"agents": [
{
"id": "agent_01h9krwprkeee8fzqspvwy6nq8",
"display_name": "string",
"first_name": "string",
"last_name": "string",
"address": "string",
"tags": {},
"updated_at": "2022-12-05T22:32:45.162Z",
"created_at": "2023-06-08T12:00:49.203Z",
"deleted_at": "2023-03-18T22:14:50.169Z"
}
],
"pagination": {
"page": 284000,
"prev": "string",
"next": "string",
"self": "string"
}
}
Agents & Agent Pools

Remove Agent From Agent Pool

This operation removes an Agent from an AgentPool

Parameters

TypeScript
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

TypeScript
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*[]>
RemoveAgentFromAgentPool.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const agentPoolId = "01h9krwprkeee8fzqspvwy6nq8";
const agentId = "agent_01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.agentsAndAgentPools.removeAgentFromAgentPool(agentPoolId, agentId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"code": 633062,
"message": "string",
"more_info": "http://uniform-limestone.info"
}

Domains

Available Operations

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

TypeScript
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

TypeScript
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*[]>
CreateDomain.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { } from "Twilio-Communications-API/models";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.domains.createDomain({
domainName: "example.com",
capabilities: [
DomainCapability.Links,
],
});

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "domain_01h9krwprkeee8fzqspvwy6nq8",
"domain_name": "example.com",
"parent_domain": {
"id": "domain_01h9krwprkeee8fzqspvwy6nq8",
"domain_name": "example.com"
},
"sub_domains": [
{
"id": "domain_01h9krwprkeee8fzqspvwy6nq8",
"domain_name": "example.com"
}
],
"is_default": false,
"capabilities": [],
"dns": [
{
"host": "string",
"value": "string",
"is_verified": false,
"last_verify_attempt_at": "2023-10-11T22:05:23.483Z",
"updated_at": "2023-01-05T21:00:17.985Z"
}
],
"created_at": "2023-04-19T05:40:14.539Z",
"updated_at": "2024-11-29T15:51:58.240Z",
"deleted_at": "2023-10-12T16:29:32.168Z"
}
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

TypeScript
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

TypeScript
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*[]>
ListDomains.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.domains.listDomains();

// Handle the result
console.log(result)
}

run();
Example Response
{
"domains": [
{
"id": "domain_01h9krwprkeee8fzqspvwy6nq8",
"domain_name": "example.com",
"parent_domain": {
"id": "domain_01h9krwprkeee8fzqspvwy6nq8",
"domain_name": "example.com"
},
"sub_domains": [
{
"id": "domain_01h9krwprkeee8fzqspvwy6nq8",
"domain_name": "example.com"
}
],
"is_default": false,
"capabilities": [],
"dns": [
{
"host": "string",
"value": "string",
"is_verified": false,
"last_verify_attempt_at": "2023-12-22T02:14:53.482Z",
"updated_at": "2023-01-12T08:34:33.439Z"
}
],
"created_at": "2023-12-16T22:20:05.073Z",
"updated_at": "2023-10-10T18:22:17.403Z",
"deleted_at": "2024-06-19T14:29:06.544Z"
}
],
"pagination": {
"page": 659177,
"prev": "string",
"next": "string",
"self": "string"
}
}
Domains

Fetch One Domain

This operation fetches a Domain by its unique identifier.

Parameters

TypeScript
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

TypeScript
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*[]>
FetchOneDomain.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const domainId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.domains.fetchOneDomain(domainId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "domain_01h9krwprkeee8fzqspvwy6nq8",
"domain_name": "example.com",
"parent_domain": {
"id": "domain_01h9krwprkeee8fzqspvwy6nq8",
"domain_name": "example.com"
},
"sub_domains": [
{
"id": "domain_01h9krwprkeee8fzqspvwy6nq8",
"domain_name": "example.com"
}
],
"is_default": false,
"capabilities": [],
"dns": [
{
"host": "string",
"value": "string",
"is_verified": false,
"last_verify_attempt_at": "2024-12-31T05:00:29.484Z",
"updated_at": "2024-12-15T03:45:01.172Z"
}
],
"created_at": "2023-01-21T16:11:36.352Z",
"updated_at": "2023-05-07T03:56:56.428Z",
"deleted_at": "2024-03-01T15:52:50.983Z"
}
Domains

Update Domain

This operation updates a Domain by its unique identifier.

Parameters

TypeScript
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

TypeScript
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*[]>
UpdateDomain.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { } from "Twilio-Communications-API/models";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const domainId = "01h9krwprkeee8fzqspvwy6nq8";
const requestBody = {
capabilities: [
DomainCapability.Email,
],
};

const result = await sdk.domains.updateDomain(domainId, requestBody);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "domain_01h9krwprkeee8fzqspvwy6nq8",
"domain_name": "example.com",
"parent_domain": {
"id": "domain_01h9krwprkeee8fzqspvwy6nq8",
"domain_name": "example.com"
},
"sub_domains": [
{
"id": "domain_01h9krwprkeee8fzqspvwy6nq8",
"domain_name": "example.com"
}
],
"is_default": false,
"capabilities": [],
"dns": [
{
"host": "string",
"value": "string",
"is_verified": false,
"last_verify_attempt_at": "2024-06-10T02:34:07.582Z",
"updated_at": "2022-10-20T07:11:40.624Z"
}
],
"created_at": "2024-12-05T22:38:23.244Z",
"updated_at": "2023-09-11T05:08:55.535Z",
"deleted_at": "2024-09-02T05:07:56.253Z"
}
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

TypeScript
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

TypeScript
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*[]>
CheckDomain.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const domainId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.domains.checkDomain(domainId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "domain_01h9krwprkeee8fzqspvwy6nq8",
"domain_name": "example.com",
"parent_domain": {
"id": "domain_01h9krwprkeee8fzqspvwy6nq8",
"domain_name": "example.com"
},
"sub_domains": [
{
"id": "domain_01h9krwprkeee8fzqspvwy6nq8",
"domain_name": "example.com"
}
],
"is_default": false,
"capabilities": [],
"dns": [
{
"host": "string",
"value": "string",
"is_verified": false,
"last_verify_attempt_at": "2024-02-05T06:43:41.039Z",
"updated_at": "2022-10-26T08:43:16.322Z"
}
],
"created_at": "2023-01-03T16:56:38.372Z",
"updated_at": "2022-03-31T22:26:48.990Z",
"deleted_at": "2022-06-11T20:43:17.206Z"
}

Content And Media

*Use Content & Media to build, store, and retrieve reusable content templates and media files.*

Available Operations

Content & Media

Upload Media

This operation uploads a Media file.

Parameters

TypeScript
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

TypeScript
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*[]>
UploadMedia.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.contentAndMedia.uploadMedia();

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "media_01h9krwprkeee8fzqspvwy6nq8",
"file_name": "string",
"file_size": 626.36,
"mime_type": "text/plain",
"content_reference": {
"temporary_url": "http://essential-cat.info",
"expires_at": "2022-10-13T15:34:35.218Z"
},
"tags": {},
"created_by": {
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8"
},
"updated_at": "2024-08-12T16:57:21.311Z",
"created_at": "2024-04-27T07:11:23.285Z",
"deleted_at": "2022-07-16T15:12:08.729Z"
}
Content & Media

List Media

This operation fetches a paginated list of Media.

Parameters

TypeScript
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

TypeScript
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*[]>
ListMedia.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { MediaUploadStatus } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.contentAndMedia.listMedia({
mimeType: "text/plain",
});

// Handle the result
console.log(result)
}

run();
Example Response
{
"media": [
{
"id": "media_01h9krwprkeee8fzqspvwy6nq8",
"file_name": "string",
"file_size": 4332.79,
"mime_type": "text/plain",
"content_reference": {
"temporary_url": "http://general-brilliant.name",
"expires_at": "2023-10-09T07:19:47.340Z"
},
"tags": {},
"created_by": {
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8"
},
"updated_at": "2024-03-27T22:57:03.217Z",
"created_at": "2024-10-28T02:19:14.729Z",
"deleted_at": "2024-07-18T13:44:51.693Z"
}
],
"pagination": {
"page": 52508,
"prev": "string",
"next": "string",
"self": "string"
}
}
Content & Media

Fetch Single Media

This operation fetches a single Media object using its ID.

Parameters

TypeScript
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

TypeScript
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*[]>
FetchSingleMedia.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const mediaId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.contentAndMedia.fetchSingleMedia(mediaId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "media_01h9krwprkeee8fzqspvwy6nq8",
"file_name": "string",
"file_size": 5962.11,
"mime_type": "text/plain",
"content_reference": {
"temporary_url": "https://unique-great-grandmother.net",
"expires_at": "2023-02-21T20:20:12.317Z"
},
"tags": {},
"created_by": {
"address": "string"
},
"updated_at": "2024-04-18T10:24:49.909Z",
"created_at": "2024-01-21T16:30:55.798Z",
"deleted_at": "2022-07-27T05:06:14.785Z"
}

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

Event Subscriptions

Create Subscription

This operation creates an event subscription.

Parameters

TypeScript
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

TypeScript
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*[]>
CreateSubscription.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.eventSubscriptions.createSubscription({
filters: {
eventFilters: [
{
type: EventType.MessageSent,
schemaVersionId: "string",
},
],
resourceFilters: [
,
],
},
sinks: {},
});

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "subscription_01h9krwprkeee8fzqspvwy6nq8",
"enabled": false,
"filters": {
"event_filters": [
{
"schema_version_id": "string"
}
],
"resource_filters": [
{
"audience_ids": [
"audience_01h9krwprkeee8fzqspvwy6nq8"
]
}
]
},
"sinks": {
"primary": {
"sink_id": "sink_01h9krwprkeee8fzqspvwy6nq8"
},
"fallback": {
"sink_id": "sink_01h9krwprkeee8fzqspvwy6nq8"
}
}
}
Event Subscriptions

Get Subscriptions

This operation fetches a paginated list of event Subscriptions.

Parameters

TypeScript
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

TypeScript
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*[]>
GetSubscriptions.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const enabled = false;
const startDate = new Date("2024-05-25T21:04:00.708Z");
const endDate = new Date("2024-05-27T19:09:23.162Z");

const result = await sdk.eventSubscriptions.getSubscriptions(enabled, startDate, endDate);

// Handle the result
console.log(result)
}

run();
Example Response
{
"subscriptions": [
{
"id": "subscription_01h9krwprkeee8fzqspvwy6nq8",
"enabled": false,
"filters": {
"event_filters": [
{
"schema_version_id": "string"
}
],
"resource_filters": [
{
"conversation_ids": [
"conversation_01h9krwprkeee8fzqspvwy6nq8"
]
}
]
},
"sinks": {
"primary": {
"url": "http://lonely-outlaw.name",
"timeout_ms": 382440,
"retries": 241557
},
"fallback": {
"url": "http://worse-strength.org",
"timeout_ms": 58534,
"retries": 271113
}
}
}
]
}
Event Subscriptions

Fetch Single Subscription

This operation fetches a single event Subscription using its Id.

Parameters

TypeScript
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

TypeScript
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*[]>
FetchSingleSubscription.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const subscriptionId = "subscription_01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.eventSubscriptions.fetchSingleSubscription(subscriptionId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "subscription_01h9krwprkeee8fzqspvwy6nq8",
"enabled": false,
"filters": {
"event_filters": [
{
"schema_version_id": "string"
}
],
"resource_filters": [
{
"audience_ids": [
"audience_01h9krwprkeee8fzqspvwy6nq8"
]
}
]
},
"sinks": {
"primary": {
"flow_id": "flow_01h9krwprkeee8fzqspvwy6nq8"
},
"fallback": {
"url": "http://joyful-lentil.org",
"timeout_ms": 967260,
"retries": 423706
}
}
}
Event Subscriptions

Update Single Subscription

This operation updates an event Subscription using its Id.

Parameters

TypeScript
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

TypeScript
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*[]>
UpdateSingleSubscription.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const subscriptionId = "string";
const requestBody = {
filters: {
eventFilters: [
{
type: EventType.MessageSent,
schemaVersionId: "string",
},
],
},
sinks: {},
};

const result = await sdk.eventSubscriptions.updateSingleSubscription(subscriptionId, requestBody);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "subscription_01h9krwprkeee8fzqspvwy6nq8",
"enabled": false,
"filters": {
"event_filters": [
{
"schema_version_id": "string"
}
],
"resource_filters": [
{
"conversation_ids": [
"conversation_01h9krwprkeee8fzqspvwy6nq8"
]
}
]
},
"sinks": {
"primary": {
"sink_id": "sink_01h9krwprkeee8fzqspvwy6nq8"
},
"fallback": {
"url": "http://left-dissonance.info",
"timeout_ms": 403793,
"retries": 235263
}
}
}
Event Subscriptions

Get Sinks

This operation fetches a paginated list of event Sinks (destinations for event Subscriptions).

Parameters

TypeScript
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

TypeScript
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*[]>
GetSinks.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.eventSubscriptions.getSinks();

// Handle the result
console.log(result)
}

run();
Example Response
{
"sinks": [
{
"id": "sink_01h9krwprkeee8fzqspvwy6nq8",
"name": "string",
"configuration": {
"flow_id": "flow_01h9krwprkeee8fzqspvwy6nq8"
}
}
]
}
Event Subscriptions

Create Sink

This operation creates an event Sink (destination for an event Subscription)

Parameters

TypeScript
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

TypeScript
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*[]>
CreateSink.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.eventSubscriptions.createSink({});

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "sink_01h9krwprkeee8fzqspvwy6nq8",
"name": "string",
"configuration": {
"url": "https://cloudy-filing.org",
"timeout_ms": 713767,
"retries": 399667
}
}
Event Subscriptions

Get Schemas

This operation fetches a paginated list of event Schemas.

Parameters

TypeScript
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

TypeScript
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*[]>
GetSchemas.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.eventSubscriptions.getSchemas();

// Handle the result
console.log(result)
}

run();
Example Response
{
"schemas": [
{
"latest_version": {
"id": "string",
"raw_url": "https://helpful-gravity.com",
"changelog_url": "http://hasty-orchard.name",
"created_at": "2022-03-18T18:23:23.037Z",
"deprecated_at": "2023-11-17T09:25:19.396Z"
},
"all_versions": [
{
"id": "string",
"raw_url": "https://upset-pharmacopoeia.net",
"changelog_url": "https://gargantuan-management.biz",
"created_at": "2022-05-02T01:59:23.702Z",
"deprecated_at": "2024-07-02T07:32:20.657Z"
}
]
}
]
}
Event Subscriptions

Read Schemas By Type

This operation fetches a paginated list of event Schemas using their event type.

Parameters

TypeScript
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

TypeScript
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*[]>
ReadSchemasByType.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const eventType = "string";

const result = await sdk.eventSubscriptions.readSchemasByType(eventType);

// Handle the result
console.log(result)
}

run();
Example Response
{
"schemas": {
"latest_version": {
"id": "string",
"raw_url": "http://solid-guinea.biz",
"changelog_url": "http://sad-animal.name",
"created_at": "2024-03-19T00:44:08.177Z",
"deprecated_at": "2023-03-15T00:39:25.767Z"
},
"all_versions": [
{
"id": "string",
"raw_url": "http://messy-occupation.com",
"changelog_url": "https://quaint-parsnip.com",
"created_at": "2024-11-17T05:16:39.880Z",
"deprecated_at": "2024-09-01T15:48:48.906Z"
}
]
}
}
Event Subscriptions

Fetch Event Schema Raw

This operation fetches a raw event Schema using its type and version.

Parameters

TypeScript
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

TypeScript
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*[]>
FetchEventSchemaRaw.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const eventType = "string";
const versionId = "string";

const result = await sdk.eventSubscriptions.fetchEventSchemaRaw(eventType, versionId);

// Handle the result
console.log(result)
}

run();

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

Conversations

List Conversations

This operation fetches a paginated list of Conversations.

Parameters

TypeScript
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

TypeScript
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*[]>
ListConversations.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { } from "Twilio-Communications-API/models";
import { ConversationState } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.conversations.listConversations({
participantChannels: [
CommunicationChannel.Fbm,
],
});

// Handle the result
console.log(result)
}

run();
Example Response
{
"conversations": [
{
"id": "conversation_01h9krwprkeee8fzqspvwy6nq8",
"title": "string",
"participant_count": 103298,
"participant_channels": [],
"message_count": 867168,
"time_to": {
"inactive": "2022-02-01T23:49:12.325Z",
"closed": "2022-01-02T07:45:50.322Z",
"deleted": "2023-08-10T06:27:10.605Z"
},
"tags": {},
"created_at": "2024-10-24T04:36:14.577Z",
"updated_at": "2023-03-20T01:13:26.553Z",
"deleted_at": "2024-11-16T07:19:00.301Z"
}
],
"pagination": {
"page": 524184,
"prev": "string",
"next": "string",
"self": "string"
}
}
Conversations

Patch Conversation

This operation partially updates a Conversation.

Parameters

TypeScript
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

TypeScript
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*[]>
PatchConversation.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { UpdateConversationState } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const conversationId = "01h9krwprkeee8fzqspvwy6nq8";
const requestBody = {
timeTo: {},
tags: {
"key": {},
},
};

const result = await sdk.conversations.patchConversation(conversationId, requestBody);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "conversation_01h9krwprkeee8fzqspvwy6nq8",
"title": "string",
"participant_count": 796320,
"participant_channels": [],
"message_count": 992074,
"time_to": {
"inactive": "2023-01-25T07:50:37.582Z",
"closed": "2022-01-21T23:00:31.318Z",
"deleted": "2024-07-18T18:44:21.674Z"
},
"tags": {},
"created_at": "2023-07-22T21:24:45.272Z",
"updated_at": "2024-04-24T15:49:18.836Z",
"deleted_at": "2024-07-12T16:24:09.257Z"
}
Conversations

Fetch One Conversation

This operation fetches a single Conversation using its id.

Parameters

TypeScript
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

TypeScript
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*[]>
FetchOneConversation.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const conversationId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.conversations.fetchOneConversation(conversationId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "conversation_01h9krwprkeee8fzqspvwy6nq8",
"title": "string",
"participant_count": 720528,
"participant_channels": [],
"message_count": 633415,
"time_to": {
"inactive": "2022-12-03T21:13:17.170Z",
"closed": "2022-03-30T06:18:49.679Z",
"deleted": "2023-08-12T20:35:15.275Z"
},
"tags": {},
"created_at": "2022-04-04T12:01:07.035Z",
"updated_at": "2022-10-28T22:25:19.613Z",
"deleted_at": "2022-08-31T15:36:43.704Z"
}
Conversations

Create Participant

This operation creates a Participant

Parameters

TypeScript
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

TypeScript
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*[]>
CreateParticipant.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const conversationId = "01h9krwprkeee8fzqspvwy6nq8";
const requestBody = {
agentId: "agent_01h9krwprkeee8fzqspvwy6nq8",
contactId: "contact_01h9krwprkeee8fzqspvwy6nq8",
addresses: [
{
address: "7617 McCullough Coves",
channel: CommunicationChannel.Gbm,
},
],
lastReadMessage: {
id: "message_01h9krwprkeee8fzqspvwy6nq8",
},
tags: {
"key": {},
},
};

const result = await sdk.conversations.createParticipant(conversationId, requestBody);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "participant_01h9krwprkeee8fzqspvwy6nq8",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8",
"addresses": [
{
"address": "string"
}
],
"last_read_message": {
"id": "message_01h9krwprkeee8fzqspvwy6nq8",
"timestamp": "2022-04-20T14:46:11.627Z"
},
"tags": {},
"created_at": "2022-01-28T08:08:46.184Z",
"updated_at": "2022-10-18T11:36:15.419Z",
"deleted_at": "2022-06-08T03:18:05.540Z"
}
Conversations

List Participants

This operation fetches a paginated list of Participants.

Parameters

TypeScript
conversationId: string

Example: [object Object]

channel?: components.CommunicationChannel

Filter to Participants that match a specific channel.

Show child properties
NameValue
emailemail
teltel
whatsappwhatsapp
fbmfbm
gbmgbm
chatchat
apnapn
fcmfcm
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

TypeScript
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*[]>
ListParticipants.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { CommunicationChannel } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const conversationId = "01h9krwprkeee8fzqspvwy6nq8";
const channel = CommunicationChannel.Fcm;

const result = await sdk.conversations.listParticipants(conversationId, channel);

// Handle the result
console.log(result)
}

run();
Example Response
{
"participants": [
{
"id": "participant_01h9krwprkeee8fzqspvwy6nq8",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8",
"addresses": [
{
"address": "string"
}
],
"last_read_message": {
"id": "message_01h9krwprkeee8fzqspvwy6nq8",
"timestamp": "2023-07-18T01:56:09.832Z"
},
"tags": {},
"created_at": "2022-03-13T21:40:13.733Z",
"updated_at": "2022-09-02T00:47:39.361Z",
"deleted_at": "2024-07-27T11:29:19.399Z"
}
],
"pagination": {
"page": 369490,
"prev": "string",
"next": "string",
"self": "string"
}
}
Conversations

Fetch Single Participant

This operation fetches a single conversation participant using its ID.

Parameters

TypeScript
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

TypeScript
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*[]>
FetchSingleParticipant.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const conversationId = "01h9krwprkeee8fzqspvwy6nq8";
const participantId = "participant_01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.conversations.fetchSingleParticipant(conversationId, participantId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "participant_01h9krwprkeee8fzqspvwy6nq8",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"agent_id": "agent_01h9krwprkeee8fzqspvwy6nq8",
"addresses": [
{
"address": "string"
}
],
"last_read_message": {
"id": "message_01h9krwprkeee8fzqspvwy6nq8",
"timestamp": "2022-03-02T09:32:30.763Z"
},
"tags": {},
"created_at": "2023-09-06T09:53:08.989Z",
"updated_at": "2024-09-25T16:07:48.339Z",
"deleted_at": "2024-04-27T16:58:28.547Z"
}

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

Identity Verification

Start Verification

This operation initiates a Verification session.

Parameters

TypeScript
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

TypeScript
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*[]>
StartVerification.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { PushNotificationPriority } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.identityVerification.startVerification({
processingOptions: {
usePreference: {},
messages: {},
emails: {
replyTo: [
,
],
cc: [
,
],
bcc: [
,
],
},
pushNotifications: {},
},
tags: {
"key": {},
},
});

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "verification_01h9krwprkeee8fzqspvwy6nq8",
"to": {
"phone_number": "string",
"device_ip": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"user_identifier": {
"user_identifier": "string"
}
},
"silent_network_auth_url": "https://crisp-fairness.biz",
"related": [
{
"id": "string",
"uri": "string"
}
],
"tags": {},
"created_at": "2023-04-20T13:12:59.565Z",
"updated_at": "2023-04-13T22:19:10.326Z",
"deleted_at": "2023-08-02T22:40:10.384Z"
}
Identity Verification

List Verifications

This operation fetches a paginated list of Verifications.

Parameters

TypeScript
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

TypeScript
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*[]>
ListVerifications.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { CommunicationChannel, FactorType, VerificationStatus } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.identityVerification.listVerifications({
contactId: "contact_01h9krwprkeee8fzqspvwy6nq8",
});

// Handle the result
console.log(result)
}

run();
Example Response
{
"verifications": [
{
"id": "verification_01h9krwprkeee8fzqspvwy6nq8",
"to": {
"address": "string",
"address_extension": 3494.4,
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"user_identifier": "string"
},
"silent_network_auth_url": "https://impossible-riddle.info",
"related": [
{
"id": "string",
"uri": "string"
}
],
"tags": {},
"created_at": "2022-06-25T18:59:30.281Z",
"updated_at": "2022-02-01T17:34:04.584Z",
"deleted_at": "2023-01-19T19:51:06.284Z"
}
],
"pagination": {
"page": 895692,
"prev": "string",
"next": "string",
"self": "string"
}
}
Identity Verification

Fetch Verification Settings

This operation fetches the current Verification settings.

Parameters

TypeScript
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

TypeScript
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*[]>
FetchVerificationSettings.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.identityVerification.fetchVerificationSettings();

// Handle the result
console.log(result)
}

run();
Example Response
{
"time_to_expire": "PT10M",
"time_to_delete": "P30D"
}
Identity Verification

Update Verifications Settings

This operation partially updates the current Verifications resoure collection settings.

Parameters

TypeScript
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

TypeScript
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*[]>
UpdateVerificationsSettings.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { FraudGuardLevel } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.identityVerification.updateVerificationsSettings({
timeToExpire: "PT10M",
timeToDelete: "P30D",
});

// Handle the result
console.log(result)
}

run();
Example Response
{
"time_to_expire": "PT10M",
"time_to_delete": "P30D"
}
Identity Verification

Fetch Single Verification

This operation fetches a single Verification using its Id.

Parameters

TypeScript
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

TypeScript
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*[]>
FetchSingleVerification.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const verificationId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.identityVerification.fetchSingleVerification(verificationId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "verification_01h9krwprkeee8fzqspvwy6nq8",
"to": {
"phone_number": "string",
"device_ip": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"user_identifier": {
"user_identifier": "string"
}
},
"silent_network_auth_url": "https://remarkable-concern.org",
"related": [
{
"id": "string",
"uri": "string"
}
],
"tags": {},
"created_at": "2024-04-12T04:09:55.831Z",
"updated_at": "2023-09-28T07:55:34.077Z",
"deleted_at": "2023-02-04T12:58:54.972Z"
}
Identity Verification

Delete Verification

This operation deletes a Verification

Parameters

TypeScript
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

TypeScript
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*[]>
DeleteVerification.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const verificationId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.identityVerification.deleteVerification(verificationId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"code": 455898,
"message": "string",
"more_info": "https://powerful-garb.biz"
}
Identity Verification

Approve Verification

This operation approves a Verification

Parameters

TypeScript
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

TypeScript
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*[]>
ApproveVerification.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const verificationId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.identityVerification.approveVerification(verificationId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "verification_01h9krwprkeee8fzqspvwy6nq8",
"to": {
"address": "string",
"address_extension": 5510.79,
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"user_identifier": "string"
},
"silent_network_auth_url": "http://loathsome-consumption.net",
"related": [
{
"id": "string",
"uri": "string"
}
],
"tags": {},
"created_at": "2022-10-31T23:09:30.518Z",
"updated_at": "2022-04-17T20:27:57.659Z",
"deleted_at": "2023-07-29T17:17:11.069Z"
}
Identity Verification

Cancel Verification

This operation cancels a Verification

Parameters

TypeScript
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

TypeScript
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*[]>
CancelVerification.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const verificationId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.identityVerification.cancelVerification(verificationId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "verification_01h9krwprkeee8fzqspvwy6nq8",
"to": {
"phone_number": "string",
"device_ip": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"user_identifier": {
"user_identifier": "string"
}
},
"silent_network_auth_url": "http://cumbersome-curtain.com",
"related": [
{
"id": "string",
"uri": "string"
}
],
"tags": {},
"created_at": "2024-11-29T22:07:11.339Z",
"updated_at": "2024-03-29T12:47:02.537Z",
"deleted_at": "2022-01-05T05:32:33.791Z"
}
Identity Verification

Check Verification

This operation checks a Verification

Parameters

TypeScript
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

TypeScript
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*[]>
CheckVerification.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const verificationId = "01h9krwprkeee8fzqspvwy6nq8";
const requestBody = {};

const result = await sdk.identityVerification.checkVerification(verificationId, requestBody);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "verification_01h9krwprkeee8fzqspvwy6nq8",
"to": {
"factor_id": "factor_01h9krwprkeee8fzqspvwy6nq8",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"user_identifier": "string"
},
"silent_network_auth_url": "https://dead-bidder.net",
"related": [
{
"id": "string",
"uri": "string"
}
],
"tags": {},
"created_at": "2024-12-06T13:47:40.819Z",
"updated_at": "2024-02-28T16:53:18.712Z",
"deleted_at": "2023-10-30T00:26:17.739Z"
}
Identity Verification

Create Factor

This operation creates a Factor.

Parameters

TypeScript
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

TypeScript
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*[]>
CreateFactor.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { FactorType } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.identityVerification.createFactor({
type: FactorType.Passkey,
contactId: "contact_01h9krwprkeee8fzqspvwy6nq8",
config: {},
tags: {
"key": {},
},
});

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "factor_01h9krwprkeee8fzqspvwy6nq8",
"friendly_name": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"user_identifier": "string",
"related": [
{
"id": "string",
"uri": "string"
}
],
"tags": {},
"created_at": "2024-05-29T18:00:50.361Z",
"updated_at": "2022-11-26T05:49:06.187Z",
"deleted_at": "2024-07-05T15:43:09.972Z"
}
Identity Verification

List Factors

This operation fetches a paginated list of Factors.

Parameters

TypeScript
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

TypeScript
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*[]>
ListFactors.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { FactorStatus, FactorType } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const result = await sdk.identityVerification.listFactors({
contactId: "contact_01h9krwprkeee8fzqspvwy6nq8",
});

// Handle the result
console.log(result)
}

run();
Example Response
{
"factors": [
{
"id": "factor_01h9krwprkeee8fzqspvwy6nq8",
"friendly_name": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"user_identifier": "string",
"related": [
{
"id": "string",
"uri": "string"
}
],
"tags": {},
"created_at": "2023-04-01T12:09:35.022Z",
"updated_at": "2023-07-25T18:06:31.513Z",
"deleted_at": "2024-10-23T12:46:35.232Z"
}
],
"pagination": {
"page": 267207,
"prev": "string",
"next": "string",
"self": "string"
}
}
Identity Verification

Update Factor

This operation partially updates a Factor.

Parameters

TypeScript
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

TypeScript
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*[]>
UpdateFactor.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";
import { FactorStatus } from "Twilio-Communications-API/models/components";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const factorId = "01h9krwprkeee8fzqspvwy6nq8";
const requestBody = {
contactId: "contact_01h9krwprkeee8fzqspvwy6nq8",
config: {},
};

const result = await sdk.identityVerification.updateFactor(factorId, requestBody);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "factor_01h9krwprkeee8fzqspvwy6nq8",
"friendly_name": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"user_identifier": "string",
"related": [
{
"id": "string",
"uri": "string"
}
],
"tags": {},
"created_at": "2023-02-12T14:57:02.990Z",
"updated_at": "2023-04-12T20:04:56.275Z",
"deleted_at": "2022-01-02T12:23:15.961Z"
}
Identity Verification

Fetch Single Factor

This operation fetches a single Factor using its Id.

Parameters

TypeScript
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

TypeScript
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

Show child properties
headers: Record<string, *string*[]>
FetchSingleFactor.ts
import { TwillioSDKDocs } from "Twilio-Communications-API";

async function run() {
const sdk = new TwillioSDKDocs({
security: {
username: "<YOUR_USERNAME_HERE>",
password: "<YOUR_PASSWORD_HERE>",
},
});

const factorId = "01h9krwprkeee8fzqspvwy6nq8";

const result = await sdk.identityVerification.fetchSingleFactor(factorId);

// Handle the result
console.log(result)
}

run();
Example Response
{
"id": "factor_01h9krwprkeee8fzqspvwy6nq8",
"friendly_name": "string",
"contact_id": "contact_01h9krwprkeee8fzqspvwy6nq8",
"user_identifier": "string",
"related": [
{
"id": "string",
"uri": "string"
}
],
"tags": {},
"created_at": "2022-12-15T18:48:51.114Z",
"updated_at": "2023-09-23T10:23:19.435Z",
"deleted_at": "2024-07-30T05:16:57.075Z"
}