Create a new credential list mapping resourceParameters:
Parameter
Type
Required
Default
Description
DomainSid
string
Yes
—
The SID of the SIP domain that will contain the new resource.
CredentialListSid
string
Yes
—
The SID of the CredentialList resource to map to the SIP domain.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "DomainSid": { "type": "string", "description": "The SID of the SIP domain that will contain the new resource." }, "CredentialListSid": { "type": "string", "description": "The SID of the CredentialList resource to map to the SIP domain." } }, "required": [ "PCID", "DomainSid", "CredentialListSid" ]}
Create a new IP Access Control List mappingParameters:
Parameter
Type
Required
Default
Description
DomainSid
string
Yes
—
The SID of the SIP domain that will contain the new resource.
IpAccessControlListSid
string
Yes
—
The SID of the IpAccessControlList resource to map to the SIP domain.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "DomainSid": { "type": "string", "description": "The SID of the SIP domain that will contain the new resource." }, "IpAccessControlListSid": { "type": "string", "description": "The SID of the IpAccessControlList resource to map to the SIP domain." } }, "required": [ "PCID", "DomainSid", "IpAccessControlListSid" ]}
Create a new credential list mapping resourceParameters:
Parameter
Type
Required
Default
Description
DomainSid
string
Yes
—
The SID of the SIP domain that will contain the new resource.
CredentialListSid
string
Yes
—
The SID of the CredentialList resource to map to the SIP domain.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "DomainSid": { "type": "string", "description": "The SID of the SIP domain that will contain the new resource." }, "CredentialListSid": { "type": "string", "description": "The SID of the CredentialList resource to map to the SIP domain." } }, "required": [ "PCID", "DomainSid", "CredentialListSid" ]}
The unique id that identifies the credential list to include the created credential.
Password
string
Yes
—
The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg IWasAtSignal2018)
Username
string
Yes
—
The username that will be passed when authenticating SIP requests. The username should be sent in response to Twilio’s challenge of the initial INVITE. It can be up to 32 characters long.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CredentialListSid": { "type": "string", "description": "The unique id that identifies the credential list to include the created credential." }, "Password": { "type": "string", "description": "The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg `IWasAtSignal2018`)" }, "Username": { "type": "string", "description": "The username that will be passed when authenticating SIP requests. The username should be sent in response to Twilio's challenge of the initial INVITE. It can be up to 32 characters long." } }, "required": [ "PCID", "CredentialListSid", "Password", "Username" ]}
A human readable descriptive text that describes the CredentialList, up to 64 characters long.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "FriendlyName": { "type": "string", "description": "A human readable descriptive text that describes the CredentialList, up to 64 characters long." } }, "required": [ "PCID", "FriendlyName" ]}
Create a CredentialListMapping resource for an account.Parameters:
Parameter
Type
Required
Default
Description
DomainSid
string
Yes
—
A 34 character string that uniquely identifies the SIP Domain for which the CredentialList resource will be mapped.
CredentialListSid
string
Yes
—
A 34 character string that uniquely identifies the CredentialList resource to map to the SIP domain.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "DomainSid": { "type": "string", "description": "A 34 character string that uniquely identifies the SIP Domain for which the CredentialList resource will be mapped." }, "CredentialListSid": { "type": "string", "description": "A 34 character string that uniquely identifies the CredentialList resource to map to the SIP domain." } }, "required": [ "PCID", "DomainSid", "CredentialListSid" ]}
The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with.
DomainName
string
Yes
—
The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and ”-” and must end with sip.twilio.com.
EmergencyCallerSid
string
No
—
Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call.
EmergencyCallingEnabled
boolean
No
—
Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses.
FriendlyName
string
No
—
A descriptive string that you created to describe the resource. It can be up to 64 characters long.
Secure
boolean
No
—
Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain.
SipRegistration
boolean
No
—
Whether to allow SIP Endpoints to register with the domain to receive calls. Can be true or false. true allows SIP Endpoints to register with the domain to receive calls, false does not.
VoiceFallbackMethod
string
No
—
The HTTP method we should use to call voice_fallback_url. Can be: GET or POST.
VoiceFallbackUrl
string
No
—
The URL that we should call when an error occurs while retrieving or executing the TwiML from voice_url.
VoiceMethod
string
No
—
The HTTP method we should use to call voice_url. Can be: GET or POST.
VoiceStatusCallbackMethod
string
No
—
The HTTP method we should use to call voice_status_callback_url. Can be: GET or POST.
VoiceStatusCallbackUrl
string
No
—
The URL that we should call to pass status parameters (such as call ended) to your application.
VoiceUrl
string
No
—
The URL we should when the domain receives a call.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ByocTrunkSid": { "type": "string", "description": "The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with." }, "DomainName": { "type": "string", "description": "The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and \"-\" and must end with `sip.twilio.com`." }, "EmergencyCallerSid": { "type": "string", "description": "Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call." }, "EmergencyCallingEnabled": { "type": "boolean", "description": "Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses." }, "FriendlyName": { "type": "string", "description": "A descriptive string that you created to describe the resource. It can be up to 64 characters long." }, "Secure": { "type": "boolean", "description": "Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain." }, "SipRegistration": { "type": "boolean", "description": "Whether to allow SIP Endpoints to register with the domain to receive calls. Can be `true` or `false`. `true` allows SIP Endpoints to register with the domain to receive calls, `false` does not." }, "VoiceFallbackMethod": { "type": "string", "description": "The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.", "enum": [ "GET", "POST" ] }, "VoiceFallbackUrl": { "type": "string", "description": "The URL that we should call when an error occurs while retrieving or executing the TwiML from `voice_url`." }, "VoiceMethod": { "type": "string", "description": "The HTTP method we should use to call `voice_url`. Can be: `GET` or `POST`.", "enum": [ "GET", "POST" ] }, "VoiceStatusCallbackMethod": { "type": "string", "description": "The HTTP method we should use to call `voice_status_callback_url`. Can be: `GET` or `POST`.", "enum": [ "GET", "POST" ] }, "VoiceStatusCallbackUrl": { "type": "string", "description": "The URL that we should call to pass status parameters (such as call ended) to your application." }, "VoiceUrl": { "type": "string", "description": "The URL we should when the domain receives a call." } }, "required": [ "PCID", "DomainName" ]}
Create a new IpAccessControlList resourceParameters:
Parameter
Type
Required
Default
Description
FriendlyName
string
Yes
—
A human readable descriptive text that describes the IpAccessControlList, up to 255 characters long.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "FriendlyName": { "type": "string", "description": "A human readable descriptive text that describes the IpAccessControlList, up to 255 characters long." } }, "required": [ "PCID", "FriendlyName" ]}
Create a new IpAccessControlListMapping resource.Parameters:
Parameter
Type
Required
Default
Description
DomainSid
string
Yes
—
A 34 character string that uniquely identifies the SIP domain.
IpAccessControlListSid
string
Yes
—
The unique id of the IP access control list to map to the SIP domain.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "DomainSid": { "type": "string", "description": "A 34 character string that uniquely identifies the SIP domain." }, "IpAccessControlListSid": { "type": "string", "description": "The unique id of the IP access control list to map to the SIP domain." } }, "required": [ "PCID", "DomainSid", "IpAccessControlListSid" ]}
The IpAccessControlList Sid with which to associate the created IpAddress resource.
CidrPrefixLength
integer
No
—
An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used.
FriendlyName
string
Yes
—
A human readable descriptive text for this resource, up to 255 characters long.
IpAddress
string
Yes
—
An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "IpAccessControlListSid": { "type": "string", "description": "The IpAccessControlList Sid with which to associate the created IpAddress resource." }, "CidrPrefixLength": { "type": "integer", "description": "An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used." }, "FriendlyName": { "type": "string", "description": "A human readable descriptive text for this resource, up to 255 characters long." }, "IpAddress": { "type": "string", "description": "An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today." } }, "required": [ "PCID", "IpAccessControlListSid", "FriendlyName", "IpAddress" ]}
Delete a credential list mapping from the requested domainParameters:
Parameter
Type
Required
Default
Description
DomainSid
string
Yes
—
The SID of the SIP domain that contains the resource to delete.
Sid
string
Yes
—
The Twilio-provided string that uniquely identifies the CredentialListMapping resource to delete.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "DomainSid": { "type": "string", "description": "The SID of the SIP domain that contains the resource to delete." }, "Sid": { "type": "string", "description": "The Twilio-provided string that uniquely identifies the CredentialListMapping resource to delete." } }, "required": [ "PCID", "DomainSid", "Sid" ]}
Delete an IP Access Control List mapping from the requested domainParameters:
Parameter
Type
Required
Default
Description
DomainSid
string
Yes
—
The SID of the SIP domain that contains the resources to delete.
Sid
string
Yes
—
The Twilio-provided string that uniquely identifies the IpAccessControlListMapping resource to delete.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "DomainSid": { "type": "string", "description": "The SID of the SIP domain that contains the resources to delete." }, "Sid": { "type": "string", "description": "The Twilio-provided string that uniquely identifies the IpAccessControlListMapping resource to delete." } }, "required": [ "PCID", "DomainSid", "Sid" ]}
Delete a credential list mapping from the requested domainParameters:
Parameter
Type
Required
Default
Description
DomainSid
string
Yes
—
The SID of the SIP domain that contains the resources to delete.
Sid
string
Yes
—
The Twilio-provided string that uniquely identifies the CredentialListMapping resource to delete.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "DomainSid": { "type": "string", "description": "The SID of the SIP domain that contains the resources to delete." }, "Sid": { "type": "string", "description": "The Twilio-provided string that uniquely identifies the CredentialListMapping resource to delete." } }, "required": [ "PCID", "DomainSid", "Sid" ]}
The unique id that identifies the credential list that contains the desired credentials.
Sid
string
Yes
—
The unique id that identifies the resource to delete.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CredentialListSid": { "type": "string", "description": "The unique id that identifies the credential list that contains the desired credentials." }, "Sid": { "type": "string", "description": "The unique id that identifies the resource to delete." } }, "required": [ "PCID", "CredentialListSid", "Sid" ]}
Delete a CredentialListMapping resource from an account.Parameters:
Parameter
Type
Required
Default
Description
DomainSid
string
Yes
—
A 34 character string that uniquely identifies the SIP Domain that includes the resource to delete.
Sid
string
Yes
—
A 34 character string that uniquely identifies the resource to delete.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "DomainSid": { "type": "string", "description": "A 34 character string that uniquely identifies the SIP Domain that includes the resource to delete." }, "Sid": { "type": "string", "description": "A 34 character string that uniquely identifies the resource to delete." } }, "required": [ "PCID", "DomainSid", "Sid" ]}
Delete an IpAccessControlListMapping resource.Parameters:
Parameter
Type
Required
Default
Description
DomainSid
string
Yes
—
A 34 character string that uniquely identifies the SIP domain.
Sid
string
Yes
—
A 34 character string that uniquely identifies the resource to delete.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "DomainSid": { "type": "string", "description": "A 34 character string that uniquely identifies the SIP domain." }, "Sid": { "type": "string", "description": "A 34 character string that uniquely identifies the resource to delete." } }, "required": [ "PCID", "DomainSid", "Sid" ]}
The IpAccessControlList Sid that identifies the IpAddress resources to delete.
Sid
string
Yes
—
A 34 character string that uniquely identifies the resource to delete.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "IpAccessControlListSid": { "type": "string", "description": "The IpAccessControlList Sid that identifies the IpAddress resources to delete." }, "Sid": { "type": "string", "description": "A 34 character string that uniquely identifies the resource to delete." } }, "required": [ "PCID", "IpAccessControlListSid", "Sid" ]}
Fetch a specific instance of a credential list mappingParameters:
Parameter
Type
Required
Default
Description
DomainSid
string
Yes
—
The SID of the SIP domain that contains the resource to fetch.
Sid
string
Yes
—
The Twilio-provided string that uniquely identifies the CredentialListMapping resource to fetch.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "DomainSid": { "type": "string", "description": "The SID of the SIP domain that contains the resource to fetch." }, "Sid": { "type": "string", "description": "The Twilio-provided string that uniquely identifies the CredentialListMapping resource to fetch." } }, "required": [ "PCID", "DomainSid", "Sid" ]}
Fetch a specific instance of an IP Access Control List mappingParameters:
Parameter
Type
Required
Default
Description
DomainSid
string
Yes
—
The SID of the SIP domain that contains the resource to fetch.
Sid
string
Yes
—
The Twilio-provided string that uniquely identifies the IpAccessControlListMapping resource to fetch.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "DomainSid": { "type": "string", "description": "The SID of the SIP domain that contains the resource to fetch." }, "Sid": { "type": "string", "description": "The Twilio-provided string that uniquely identifies the IpAccessControlListMapping resource to fetch." } }, "required": [ "PCID", "DomainSid", "Sid" ]}
Fetch a specific instance of a credential list mappingParameters:
Parameter
Type
Required
Default
Description
DomainSid
string
Yes
—
The SID of the SIP domain that contains the resource to fetch.
Sid
string
Yes
—
The Twilio-provided string that uniquely identifies the CredentialListMapping resource to fetch.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "DomainSid": { "type": "string", "description": "The SID of the SIP domain that contains the resource to fetch." }, "Sid": { "type": "string", "description": "The Twilio-provided string that uniquely identifies the CredentialListMapping resource to fetch." } }, "required": [ "PCID", "DomainSid", "Sid" ]}
The unique id that identifies the credential list that contains the desired credential.
Sid
string
Yes
—
The unique id that identifies the resource to fetch.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CredentialListSid": { "type": "string", "description": "The unique id that identifies the credential list that contains the desired credential." }, "Sid": { "type": "string", "description": "The unique id that identifies the resource to fetch." } }, "required": [ "PCID", "CredentialListSid", "Sid" ]}
Fetch a single CredentialListMapping resource from an account.Parameters:
Parameter
Type
Required
Default
Description
DomainSid
string
Yes
—
A 34 character string that uniquely identifies the SIP Domain that includes the resource to fetch.
Sid
string
Yes
—
A 34 character string that uniquely identifies the resource to fetch.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "DomainSid": { "type": "string", "description": "A 34 character string that uniquely identifies the SIP Domain that includes the resource to fetch." }, "Sid": { "type": "string", "description": "A 34 character string that uniquely identifies the resource to fetch." } }, "required": [ "PCID", "DomainSid", "Sid" ]}
Fetch an IpAccessControlListMapping resource.Parameters:
Parameter
Type
Required
Default
Description
DomainSid
string
Yes
—
A 34 character string that uniquely identifies the SIP domain.
Sid
string
Yes
—
A 34 character string that uniquely identifies the resource to fetch.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "DomainSid": { "type": "string", "description": "A 34 character string that uniquely identifies the SIP domain." }, "Sid": { "type": "string", "description": "A 34 character string that uniquely identifies the resource to fetch." } }, "required": [ "PCID", "DomainSid", "Sid" ]}
The IpAccessControlList Sid that identifies the IpAddress resources to fetch.
Sid
string
Yes
—
A 34 character string that uniquely identifies the IpAddress resource to fetch.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "IpAccessControlListSid": { "type": "string", "description": "The IpAccessControlList Sid that identifies the IpAddress resources to fetch." }, "Sid": { "type": "string", "description": "A 34 character string that uniquely identifies the IpAddress resource to fetch." } }, "required": [ "PCID", "IpAccessControlListSid", "Sid" ]}
Retrieve a list of credential list mappings belonging to the domain used in the requestParameters:
Parameter
Type
Required
Default
Description
DomainSid
string
Yes
—
The SID of the SIP domain that contains the resources to read.
PageSize
integer
No
—
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page
integer
No
—
The page index. This value is simply for client state.
PageToken
string
No
—
The page token. This is provided by the API.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "DomainSid": { "type": "string", "description": "The SID of the SIP domain that contains the resources to read." }, "PageSize": { "type": "integer", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, "Page": { "type": "integer", "description": "The page index. This value is simply for client state." }, "PageToken": { "type": "string", "description": "The page token. This is provided by the API." } }, "required": [ "PCID", "DomainSid" ]}
Retrieve a list of IP Access Control List mappings belonging to the domain used in the requestParameters:
Parameter
Type
Required
Default
Description
DomainSid
string
Yes
—
The SID of the SIP domain that contains the resources to read.
PageSize
integer
No
—
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page
integer
No
—
The page index. This value is simply for client state.
PageToken
string
No
—
The page token. This is provided by the API.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "DomainSid": { "type": "string", "description": "The SID of the SIP domain that contains the resources to read." }, "PageSize": { "type": "integer", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, "Page": { "type": "integer", "description": "The page index. This value is simply for client state." }, "PageToken": { "type": "string", "description": "The page token. This is provided by the API." } }, "required": [ "PCID", "DomainSid" ]}
Retrieve a list of credential list mappings belonging to the domain used in the requestParameters:
Parameter
Type
Required
Default
Description
DomainSid
string
Yes
—
The SID of the SIP domain that contains the resources to read.
PageSize
integer
No
—
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page
integer
No
—
The page index. This value is simply for client state.
PageToken
string
No
—
The page token. This is provided by the API.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "DomainSid": { "type": "string", "description": "The SID of the SIP domain that contains the resources to read." }, "PageSize": { "type": "integer", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, "Page": { "type": "integer", "description": "The page index. This value is simply for client state." }, "PageToken": { "type": "string", "description": "The page token. This is provided by the API." } }, "required": [ "PCID", "DomainSid" ]}
The unique id that identifies the credential list that contains the desired credentials.
PageSize
integer
No
—
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page
integer
No
—
The page index. This value is simply for client state.
PageToken
string
No
—
The page token. This is provided by the API.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CredentialListSid": { "type": "string", "description": "The unique id that identifies the credential list that contains the desired credentials." }, "PageSize": { "type": "integer", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, "Page": { "type": "integer", "description": "The page index. This value is simply for client state." }, "PageToken": { "type": "string", "description": "The page token. This is provided by the API." } }, "required": [ "PCID", "CredentialListSid" ]}
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page
integer
No
—
The page index. This value is simply for client state.
PageToken
string
No
—
The page token. This is provided by the API.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "PageSize": { "type": "integer", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, "Page": { "type": "integer", "description": "The page index. This value is simply for client state." }, "PageToken": { "type": "string", "description": "The page token. This is provided by the API." } }, "required": [ "PCID" ]}
Read multiple CredentialListMapping resources from an account.Parameters:
Parameter
Type
Required
Default
Description
DomainSid
string
Yes
—
A 34 character string that uniquely identifies the SIP Domain that includes the resource to read.
PageSize
integer
No
—
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page
integer
No
—
The page index. This value is simply for client state.
PageToken
string
No
—
The page token. This is provided by the API.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "DomainSid": { "type": "string", "description": "A 34 character string that uniquely identifies the SIP Domain that includes the resource to read." }, "PageSize": { "type": "integer", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, "Page": { "type": "integer", "description": "The page index. This value is simply for client state." }, "PageToken": { "type": "string", "description": "The page token. This is provided by the API." } }, "required": [ "PCID", "DomainSid" ]}
Retrieve a list of domains belonging to the account used to make the requestParameters:
Parameter
Type
Required
Default
Description
PageSize
integer
No
—
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page
integer
No
—
The page index. This value is simply for client state.
PageToken
string
No
—
The page token. This is provided by the API.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "PageSize": { "type": "integer", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, "Page": { "type": "integer", "description": "The page index. This value is simply for client state." }, "PageToken": { "type": "string", "description": "The page token. This is provided by the API." } }, "required": [ "PCID" ]}
Retrieve a list of IpAccessControlLists that belong to the account used to make the requestParameters:
Parameter
Type
Required
Default
Description
PageSize
integer
No
—
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page
integer
No
—
The page index. This value is simply for client state.
PageToken
string
No
—
The page token. This is provided by the API.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "PageSize": { "type": "integer", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, "Page": { "type": "integer", "description": "The page index. This value is simply for client state." }, "PageToken": { "type": "string", "description": "The page token. This is provided by the API." } }, "required": [ "PCID" ]}
Retrieve a list of IpAccessControlListMapping resources.Parameters:
Parameter
Type
Required
Default
Description
DomainSid
string
Yes
—
A 34 character string that uniquely identifies the SIP domain.
PageSize
integer
No
—
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page
integer
No
—
The page index. This value is simply for client state.
PageToken
string
No
—
The page token. This is provided by the API.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "DomainSid": { "type": "string", "description": "A 34 character string that uniquely identifies the SIP domain." }, "PageSize": { "type": "integer", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, "Page": { "type": "integer", "description": "The page index. This value is simply for client state." }, "PageToken": { "type": "string", "description": "The page token. This is provided by the API." } }, "required": [ "PCID", "DomainSid" ]}
The IpAccessControlList Sid that identifies the IpAddress resources to read.
PageSize
integer
No
—
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page
integer
No
—
The page index. This value is simply for client state.
PageToken
string
No
—
The page token. This is provided by the API.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "IpAccessControlListSid": { "type": "string", "description": "The IpAccessControlList Sid that identifies the IpAddress resources to read." }, "PageSize": { "type": "integer", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000." }, "Page": { "type": "integer", "description": "The page index. This value is simply for client state." }, "PageToken": { "type": "string", "description": "The page token. This is provided by the API." } }, "required": [ "PCID", "IpAccessControlListSid" ]}
The unique id that identifies the credential list that includes this credential.
Sid
string
Yes
—
The unique id that identifies the resource to update.
Password
string
No
—
The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg IWasAtSignal2018)
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "CredentialListSid": { "type": "string", "description": "The unique id that identifies the credential list that includes this credential." }, "Sid": { "type": "string", "description": "The unique id that identifies the resource to update." }, "Password": { "type": "string", "description": "The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg `IWasAtSignal2018`)" } }, "required": [ "PCID", "CredentialListSid", "Sid" ]}
The credential list Sid that uniquely identifies this resource
FriendlyName
string
Yes
—
A human readable descriptive text for a CredentialList, up to 64 characters long.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "Sid": { "type": "string", "description": "The credential list Sid that uniquely identifies this resource" }, "FriendlyName": { "type": "string", "description": "A human readable descriptive text for a CredentialList, up to 64 characters long." } }, "required": [ "PCID", "Sid", "FriendlyName" ]}
The Twilio-provided string that uniquely identifies the SipDomain resource to update.
ByocTrunkSid
string
No
—
The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with.
DomainName
string
No
—
The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and ”-” and must end with sip.twilio.com.
EmergencyCallerSid
string
No
—
Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call.
EmergencyCallingEnabled
boolean
No
—
Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses.
FriendlyName
string
No
—
A descriptive string that you created to describe the resource. It can be up to 64 characters long.
Secure
boolean
No
—
Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain.
SipRegistration
boolean
No
—
Whether to allow SIP Endpoints to register with the domain to receive calls. Can be true or false. true allows SIP Endpoints to register with the domain to receive calls, false does not.
VoiceFallbackMethod
string
No
—
The HTTP method we should use to call voice_fallback_url. Can be: GET or POST.
VoiceFallbackUrl
string
No
—
The URL that we should call when an error occurs while retrieving or executing the TwiML requested by voice_url.
VoiceMethod
string
No
—
The HTTP method we should use to call voice_url
VoiceStatusCallbackMethod
string
No
—
The HTTP method we should use to call voice_status_callback_url. Can be: GET or POST.
VoiceStatusCallbackUrl
string
No
—
The URL that we should call to pass status parameters (such as call ended) to your application.
VoiceUrl
string
No
—
The URL we should call when the domain receives a call.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "Sid": { "type": "string", "description": "The Twilio-provided string that uniquely identifies the SipDomain resource to update." }, "ByocTrunkSid": { "type": "string", "description": "The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with." }, "DomainName": { "type": "string", "description": "The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and \"-\" and must end with `sip.twilio.com`." }, "EmergencyCallerSid": { "type": "string", "description": "Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call." }, "EmergencyCallingEnabled": { "type": "boolean", "description": "Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses." }, "FriendlyName": { "type": "string", "description": "A descriptive string that you created to describe the resource. It can be up to 64 characters long." }, "Secure": { "type": "boolean", "description": "Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain." }, "SipRegistration": { "type": "boolean", "description": "Whether to allow SIP Endpoints to register with the domain to receive calls. Can be `true` or `false`. `true` allows SIP Endpoints to register with the domain to receive calls, `false` does not." }, "VoiceFallbackMethod": { "type": "string", "description": "The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.", "enum": [ "GET", "POST" ] }, "VoiceFallbackUrl": { "type": "string", "description": "The URL that we should call when an error occurs while retrieving or executing the TwiML requested by `voice_url`." }, "VoiceMethod": { "type": "string", "description": "The HTTP method we should use to call `voice_url`", "enum": [ "GET", "POST" ] }, "VoiceStatusCallbackMethod": { "type": "string", "description": "The HTTP method we should use to call `voice_status_callback_url`. Can be: `GET` or `POST`.", "enum": [ "GET", "POST" ] }, "VoiceStatusCallbackUrl": { "type": "string", "description": "The URL that we should call to pass status parameters (such as call ended) to your application." }, "VoiceUrl": { "type": "string", "description": "The URL we should call when the domain receives a call." } }, "required": [ "PCID", "Sid" ]}
A 34 character string that uniquely identifies the resource to udpate.
FriendlyName
string
Yes
—
A human readable descriptive text, up to 255 characters long.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "Sid": { "type": "string", "description": "A 34 character string that uniquely identifies the resource to udpate." }, "FriendlyName": { "type": "string", "description": "A human readable descriptive text, up to 255 characters long." } }, "required": [ "PCID", "Sid", "FriendlyName" ]}
The IpAccessControlList Sid that identifies the IpAddress resources to update.
Sid
string
Yes
—
A 34 character string that identifies the IpAddress resource to update.
CidrPrefixLength
integer
No
—
An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used.
FriendlyName
string
No
—
A human readable descriptive text for this resource, up to 255 characters long.
IpAddress
string
No
—
An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "IpAccessControlListSid": { "type": "string", "description": "The IpAccessControlList Sid that identifies the IpAddress resources to update." }, "Sid": { "type": "string", "description": "A 34 character string that identifies the IpAddress resource to update." }, "CidrPrefixLength": { "type": "integer", "description": "An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used." }, "FriendlyName": { "type": "string", "description": "A human readable descriptive text for this resource, up to 255 characters long." }, "IpAddress": { "type": "string", "description": "An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today." } }, "required": [ "PCID", "IpAccessControlListSid", "Sid" ]}