- SIP Credentials — username and password pairs used for SIP digest authentication
- IP Access Control Lists (IP ACLs) — lists of trusted IP addresses or CIDR ranges allowed to call your application
sip_auth_type, ip_acl_uuid, and credential_uuid.
For an overview of how SIP authentication works, see SIP Authentication concepts.
Account Quotas
Error Responses
All endpoints return standard HTTP status codes with a JSON error body:The Credential Object
A SIP credential is a username/password pair used for SIP digest authentication.Attributes
Passwords are stored as one-way hashes (HA1) and are never returned in API responses.
Example Object
Create a Credential
Create a new SIP credential.Arguments
3-64 characters. Allowed: alphanumeric, period (
.), underscore (_), hyphen (-). Must be unique within your account.8-128 characters. Must include at least one uppercase letter, one lowercase letter, and one digit.
Example
Response (201 Created)
Retrieve a Credential
Get details of a specific credential.Example
List All Credentials
Returns all SIP credentials for your account.Example
Update a Credential
Update the password on an existing credential. The username cannot be changed.Arguments
Example
Delete a Credential
Permanently delete a credential.Example
Response
HTTP Status Code: 204
The IP Access Control List Object
An IP ACL is a list of trusted IP addresses or CIDR ranges allowed to make inbound calls to your application.Attributes
Example Object
Create an IP ACL
Create a new IP Access Control List.Arguments
Example
Response (201 Created)
Retrieve an IP ACL
Get details of a specific IP ACL, including all entries.List All IP ACLs
Returns all IP ACLs for your account.Update an IP ACL
Update the name of an existing IP ACL.Arguments
Delete an IP ACL
Permanently delete an IP ACL and all its entries.Response
HTTP Status Code: 204
Add an Entry to an IP ACL
Add a new IP address or CIDR range to an existing IP ACL. Maximum 50 entries per ACL.Arguments
Example
Response (201 Created)
Remove an Entry from an IP ACL
Permanently delete an entry from an IP ACL.Response
HTTP Status Code: 204
Related
- SIP Authentication concepts — How SIP auth works, options, flow diagrams, and security best practices
- Application API — Assign credentials and IP ACLs to applications
- Voice API: Make a Call — Outbound SIP authentication via
sip_auth_usernameandsip_auth_password - Dial XML — Outbound SIP authentication via
sipAuthUsernameandsipAuthPassword