Class: UsAppToPersonList

Twilio.Messaging.V1.ServiceContext.UsAppToPersonList(version, messagingServiceSid)

new UsAppToPersonList(version, messagingServiceSid)

Initialize the UsAppToPersonList PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
Parameters:
Name Type Description
version Twilio.Messaging.V1 Version of the resource
messagingServiceSid string The SID of the Messaging Service the resource is associated with
Source:

Methods

create(opts, callbackopt) → {Promise}

create a UsAppToPersonInstance
Parameters:
Name Type Attributes Description
opts object Options for request
Properties
Name Type Description
brandRegistrationSid string A2P Brand Registration SID
description string A short description of what this SMS campaign does
messageSamples string | list Message samples
usAppToPersonUsecase string A2P Campaign Use Case.
hasEmbeddedLinks boolean Indicates that this SMS campaign will send messages that contain links
hasEmbeddedPhone boolean Indicates that this SMS campaign will send messages that contain phone numbers
callback function <optional>
 Callback to handle processed record
Source:
Returns:
Resolves to processed UsAppToPersonInstance
Type
Promise

each(optsopt, callbackopt)

Streams UsAppToPersonInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached. The results are passed into the callback function, so this operation is memory efficient. If a function is passed as the first argument, it will be used as the callback function.
Parameters:
Name Type Attributes Description
opts object <optional>
 Options for request
Properties
Name Type Attributes Description
limit number <optional>
 Upper limit for the number of records to return. each() guarantees never to return more than limit. Default is no limit
pageSize number <optional>
 Number of records to fetch per request, when not set will use the default value of 50 records. If no pageSize is defined but a limit is defined, each() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
callback function <optional>
 Function to process each record. If this and a positional callback are passed, this one will be used
done function <optional>
 Function to be called upon completion of streaming
callback function <optional>
 Function to process each record
Source:

get(sid) → {Twilio.Messaging.V1.ServiceContext.UsAppToPersonContext}

Constructs a us_app_to_person
Parameters:
Name Type Description
sid string The SID that identifies the US A2P Compliance resource to fetch
Source:
Returns:
Type
Twilio.Messaging.V1.ServiceContext.UsAppToPersonContext

getPage(targetUrlopt, callbackopt) → {Promise}

Retrieve a single target page of UsAppToPersonInstance records from the API. The request is executed immediately. If a function is passed as the first argument, it will be used as the callback function.
Parameters:
Name Type Attributes Description
targetUrl string <optional>
 API-generated URL for the requested results page
callback function <optional>
 Callback to handle list of records
Source:
Returns:
Resolves to a list of records
Type
Promise

list(optsopt, callbackopt) → {Promise}

Lists UsAppToPersonInstance records from the API as a list. If a function is passed as the first argument, it will be used as the callback function.
Parameters:
Name Type Attributes Description
opts object <optional>
 Options for request
Properties
Name Type Attributes Description
limit number <optional>
 Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
pageSize number <optional>
 Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
callback function <optional>
 Callback to handle list of records
Source:
Returns:
Resolves to a list of records
Type
Promise

page(optsopt, callbackopt) → {Promise}

Retrieve a single page of UsAppToPersonInstance records from the API. The request is executed immediately. If a function is passed as the first argument, it will be used as the callback function.
Parameters:
Name Type Attributes Description
opts object <optional>
 Options for request
Properties
Name Type Attributes Description
pageToken string <optional>
 PageToken provided by the API
pageNumber number <optional>
 Page Number, this value is simply for client state
pageSize number <optional>
 Number of records to return, defaults to 50
callback function <optional>
 Callback to handle list of records
Source:
Returns:
Resolves to a list of records
Type
Promise

toJSON()

Provide a user-friendly representation
Source:
Returns:
Object