Twilio. OutgoingCallerIds
(twilio v0.2.0)
Copy Markdown
API calls: create, delete, list, retrieve, update.
Summary
Functions
POST /2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds.json
Like create/2, but returns the result or raises Infusion.Runtime.Error.
Delete the caller-id specified from the account
Like delete/2, but returns the result or raises Infusion.Runtime.Error.
Retrieve a list of outgoing-caller-ids belonging to the account used to make the request
Like list/2, but returns the result or raises Infusion.Runtime.Error.
Like list/2, but returns every item, from every page: a lazy stream of Twilio.Schemas.OutgoingCallerId.t() that fetches pages as it is read.
Like list_all/2, but returns the stream or raises Infusion.Runtime.Error.
Fetch an outgoing-caller-id belonging to the account used to make the request
Like retrieve/2, but returns the result or raises Infusion.Runtime.Error.
Updates the caller-id
Like update/3, but returns the result or raises Infusion.Runtime.Error.
Functions
@spec create(map() | keyword(), keyword()) :: {:ok, Twilio.Schemas.ValidationRequest.t()} | {:error, Infusion.Runtime.Error.t()}
POST /2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds.json
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Parameters
call_delay- The number of seconds to delay before initiating the verification call. Can be an integer between0and60, inclusive. The default is0.extension- The digits to dial after connecting the verification call.friendly_name- A descriptive string that you create to describe the new caller ID resource. It can be up to 64 characters long. The default value is a formatted version of the phone number.phone_number(required) - The phone number to verify in E.164 format, which consists of a + followed by the country code and subscriber number.status_callback- The URL we should call using thestatus_callback_methodto send status information about the verification process to your application.status_callback_method- The HTTP method we should use to callstatus_callback. Can be:GETorPOST, and the default isPOST.
@spec create!(map() | keyword(), keyword()) :: Twilio.Schemas.ValidationRequest.t()
Like create/2, but returns the result or raises Infusion.Runtime.Error.
@spec delete(String.t(), keyword()) :: {:ok, nil} | {:error, Infusion.Runtime.Error.t()}
Delete the caller-id specified from the account
DELETE /2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds/{Sid}.json
Path parameters
sid(required) - The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to delete.
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Like delete/2, but returns the result or raises Infusion.Runtime.Error.
@spec list(map() | keyword(), keyword()) :: {:ok, Twilio.Schemas.OutgoingCallerIdsListResponse.t()} | {:error, Infusion.Runtime.Error.t()}
Retrieve a list of outgoing-caller-ids belonging to the account used to make the request
GET /2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds.json
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Parameters
phone_number- The phone number of the OutgoingCallerId resources to read.friendly_name- The string that identifies the OutgoingCallerId resources to read.page_size- How many resources to return in each list page. The default is 50, and the maximum is 1000.page- The page index. This value is simply for client state.page_token- The page token. This is provided by the API.
To read every item across all pages, use list_all.
@spec list!(map() | keyword(), keyword()) :: Twilio.Schemas.OutgoingCallerIdsListResponse.t()
Like list/2, but returns the result or raises Infusion.Runtime.Error.
@spec list_all(map() | keyword(), keyword()) :: {:ok, Enumerable.t()} | {:error, Infusion.Runtime.Error.t()}
Like list/2, but returns every item, from every page: a lazy stream of Twilio.Schemas.OutgoingCallerId.t() that fetches pages as it is read.
The first page is fetched right away, so its errors are returned; a later page that fails raises Infusion.Runtime.Error. Stopping early (Enum.take/2) fetches no more pages.
@spec list_all!(map() | keyword(), keyword()) :: Enumerable.t()
Like list_all/2, but returns the stream or raises Infusion.Runtime.Error.
@spec retrieve(String.t(), keyword()) :: {:ok, Twilio.Schemas.OutgoingCallerId.t()} | {:error, Infusion.Runtime.Error.t()}
Fetch an outgoing-caller-id belonging to the account used to make the request
GET /2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds/{Sid}.json
Path parameters
sid(required) - The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to fetch.
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
@spec retrieve!(String.t(), keyword()) :: Twilio.Schemas.OutgoingCallerId.t()
Like retrieve/2, but returns the result or raises Infusion.Runtime.Error.
@spec update(String.t(), map() | keyword(), keyword()) :: {:ok, Twilio.Schemas.OutgoingCallerId.t()} | {:error, Infusion.Runtime.Error.t()}
Updates the caller-id
POST /2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds/{Sid}.json
Path parameters
sid(required) - The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to update.
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Parameters
friendly_name- A descriptive string that you create to describe the resource. It can be up to 64 characters long.
@spec update!(String.t(), map() | keyword(), keyword()) :: Twilio.Schemas.OutgoingCallerId.t()
Like update/3, but returns the result or raises Infusion.Runtime.Error.