Twilio

Status: Production

Tier: Standard

Version: 1.0

Name

Summary

ListMessages ([Optional]string To, [Optional]string From, [Optional]string DateSent, [advanced][Optional]integer PageSize, [advanced][Optional]integer Page)

List Messages

SendMessage (SendMessageRequest sendMessageRequest)

Send Text Message (SMS)

GetMessage (string MessageId)

Get Message

ListIncomingPhoneNumbers ([Optional]string PhoneNumber, [Optional]string FriendlyName, [advanced][Optional]integer PageSize, [advanced][Optional]boolean Beta)

List Incoming Phone Numbers

AddIncomingNumber (AddIncomingPhoneNumberRequest addIncomingPhoneNumberRequest)

Add Incoming Number

GetIncomingPhoneNumber (string IncomingPhoneNumberSid)

Get Incoming Phone Number

GetAvailableTollFreeNumbers (string IsoCountryCode, [Optional]string AreaCode, [Optional]string Contains)

Get Available Toll Free Numbers

GetAvailableMobileNumbers (string IsoCountryCode, [Optional]string AreaCode, [Optional]string Contains, [advanced][Optional]boolean SmsEnabled, [advanced][Optional]boolean MmsEnabled, [advanced][Optional]boolean VoiceEnabled)

Get Available Mobile Numbers

GetAvailableLocalNumbers (string IsoCountryCode, [Optional]string AreaCode, [Optional]string Contains, [advanced][Optional]boolean SmsEnabled, [advanced][Optional]boolean MmsEnabled, [advanced][Optional]boolean VoiceEnabled, [Optional]string NearNumber, [Optional]string NearLatLong, [advanced][Optional]string InPostalCode, [advanced][Optional]string InRegion)

Get Available Local Numbers

ListUsage ([Optional]string Category, [advanced][Optional]string SubResource, [Optional]string EndDate, [Optional]string StartDate, [advanced][Optional]integer PageSize)

List Usage

Name

Summary

Name

Summary

AddIncomingPhoneNumberRequest

AvailablePhoneNumbers

AvailablePhoneNumberWrapper

Capabilities

IncomingPhoneNumber

IncomingPhoneNumberList

Message

Message

MessageList

Message List

SendMessageRequest

UsageRecords

Name

Type

Summary

Required

Related Action

To

string

(To Phone Number)

Only show messages to this phone number.

False

From

string

(From Phone Number)

Only show messages from this phone number.

False

ListIncomingPhoneNumbers

DateSent

string(date)

(Date Sent)

Only show messages sent on this date (in GMT format), given as YYYY-MM-DD. Example: 2009-07-06.

False

PageSize

integer(int32)

(Limit)

How many resources to return in each list page. Default is 50.

False

Page

integer(int32)

(Page)

Page number. Default is 0.

False

Name

Type

Summary

Required

Related Action

sendMessageRequest

SendMessageRequest

Request model for Send Message operation.

True

Name

Type

Summary

Required

Related Action

MessageId

string

(Message SID)

Unique SID of the message.

True

Name

Type

Summary

Required

Related Action

PhoneNumber

string

(Phone Number)

Only show the incoming phone number resources that match this pattern. You can specify partial numbers and use '*' as a wildcard for any digit.

False

FriendlyName

string

(Friendly Name)

Only show the incoming phone number resources with friendly names that exactly match this name.

False

PageSize

integer(int32)

(Limit)

Maximum number of results.

False

Beta

boolean

(Beta)

Include phone numbers new to the Twilio platform. Possible values are either true or false. Default is false.

False

Name

Type

Summary

Required

Related Action

addIncomingPhoneNumberRequest

AddIncomingPhoneNumberRequest

Request model for Add Incoming Number operation

True

Name

Type

Summary

Required

Related Action

IncomingPhoneNumberSid

string

(Incoming Phone Number ID)

Incoming Phone number ID

True

Name

Type

Summary

Required

Related Action

IsoCountryCode

string

(ISO Country Code)

Iso country code of the Toll Free Numbers

True

AreaCode

string

(Area Code)

Area Code of the Toll Free Numbers

False

Contains

string

(Contains)

Toll Free Numbers Contains a specific number

False

Name

Type

Summary

Required

Related Action

IsoCountryCode

string

(ISO Country Code)

Iso country code of the Mobile Numbers

True

AreaCode

string

(Area Code)

Area Code of the Toll Free Numbers

False

Contains

string

(Contains)

Mobile Numbers Contains a specific number

False

SmsEnabled

boolean

(SMS Enabled)

Sms Enabled on the numbers?

False

MmsEnabled

boolean

(MMS Enabled)

Mms Enabled on the numbers?

False

VoiceEnabled

boolean

(Voice Enabled)

Voice Enabled on the numbers?

False

Name

Type

Summary

Required

Related Action

IsoCountryCode

string

(ISO Country Code)

Iso country code of the Local Numbers

True

AreaCode

string

(Area Code)

Area Code of the Toll Free Numbers

False

Contains

string

(Contains)

Local Numbers Contains a specific number.

False

SmsEnabled

boolean

(SMS Enabled)

Sms Enabled on the numbers?

False

MmsEnabled

boolean

(MMS Enabled)

Mms Enabled on the numbers?

False

VoiceEnabled

boolean

(Voice Enabled)

Voice Enabled on the numbers?

False

NearNumber

string

(Near Number)

Given a phone number, find a geographically close number within Distance miles. Distance defaults to 25 miles.

False

NearLatLong

string

(Near Latitude,Longitude)

Given a latitude/longitude pair lat,long find geographically close numbers within Distance miles.

False

InPostalCode

string

(In Postal Code)

Postal code of the number

False

InRegion

string

(In Region)

Number belongs to which region

False

Name

Type

Summary

Required

Related Action

Category

string

(Category)

Category of usage

False

SubResource

string

(Sub Resource)

Sub Resource

False

EndDate

string

(End Date)

List usage upto a given date

False

StartDate

string

(Start Date)

List usage from a given date

False

PageSize

integer(int32)

(Max Results)

Maximum number of results

False

Name

Type

Summary

PhoneNumber

string

Phone Number

AreaCode

string

Area Code

FriendlyName

string

Friendly Name

Name

Type

Summary

phone_number

string

Phone Number

friendly_name

string

Friendly Name

lata

string

Local Access Transport Area

latitude

string

Latitude

longitude

string

Longitude

postal_code

string

Postal Code

rate_center

string

Rate Center

region

string

Region

MMS

boolean

Mms Enabled?

SMS

boolean

Sms Enabled?

voice

boolean

Voice Enabled?

Name

Type

Summary

available_phone_numbers

array of (AvailablePhoneNumbers)

Name

Type

Summary

mms

boolean

Mms Enabled?

sms

boolean

Sms Enabled?

voice

boolean

Voice Enabled?

Name

Type

Summary

phone_number

string

Phone Number

friendly_name

string

Friendly Name

sid

string

Id

account_sid

string

Account Sid

date_created

string

Date Created

date_updated

string

Date Updated

capabilities

Capabilities

Phone Number Capabilities

StatusCallback

string(uri)

The URL that Twilio will request to pass status parameters (such as call ended) to your application

StatusCallbackMethod

string

The HTTP method Twilio will use to make requests to the StatusCallback URL. Either GET or POST.

api_version

string

API version

Name

Type

Summary

incoming_phone_numbers

array of (IncomingPhoneNumber)

page

integer(int32)

Page number

page_size

integer(int32)

Page Size

num_pages

integer(int32)

Number of Pages

uri

string(uri)

relative URI for this list

first_page_uri

string(uri)

relative URI for the first page

next_page_uri

string(uri)

relative URI for the next page

Name

Type

Summary

body

string

Body of the message.

from

string(phone)

Phone number from which the message was sent.

to

string(phone)

Phone number to which the message was sent.

status

string

Sent status of the message.

sid

string

SID of the sent message.

account_sid

string

SID of the account associated with the sent message.

api_version

string

Version of the API used to send the message.

num_segments

string

Number of segments the message was divided into.

num_media

string

Number of media files associated with the sent message.

date_created

string

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

date_sent

string

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

date_updated

string

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

direction

string

Direction associated with the sent message.

error_code

integer

Error codes associated with the sent message, if any.

error_message

string

Error messages associated with the sent message, if any.

price

string

Cost of the sent message.

price_unit

string

Price unit used to evaluate the cost of the message.

uri

string(uri)

Relative URI for this resource.

subresource_uris

Subresource_uris

Relative URIs for any subresources.

messaging_service_sid

string

Unique id of the messaging Service.

Name

Type

Summary

Name

Type

Summary

messages

array of (Message)

page

integer(int32)

Page number of the respone.

page_size

integer(int32)

Page size of the response.

num_pages

integer(int32)

Total number of pages in the response.

start

integer(int32)

Index of the first message.

end

integer(int32)

Index of the last message.

uri

string(uri)

Relative URI for this list.

first_page_uri

string(uri)

Relative URI for the first page.

next_page_uri

string(uri)

Relative URI for the next page.

total

integer(int32)

Total number of messages.

previous_page_uri

string(uri)

Relative URI for the previous page.

Name

Type

Summary

from

string

A Twilio phone number (in E.164 format) or alphanumeric sender ID enabled for the type of message you wish to send.

to

string

The destination phone number. Format with a '+' and country code e.g., +16175551212 (E.164 format).

body

string

The text of the message you want to send, limited to 1600 characters.

media_url

array of (string(uri))

List of URIs of media to be sent.

StatusCallback

string(uri)

A URL that Twilio will POST to each time your message status changes.

messaging_service_sid

string

Unique id of the Messaging Service.

application_sid

string

SID of Twilio Application which is configured with the required Message status call back.

max_price

string

The total maximum price limit for the message.

validity_period

string

The number of seconds that the message can remain in a Twilio queue.

Name

Type

Summary

category

string

Category

usage

string

Usage

usage_unit

string

Usage Unit

description

string

Description

price

number(double)

Price

price_unit

string

Price Unit

count

string

Count

count_unit

string

Count Unit

start_date

string

Start Date

end_date

string

End Date