API docs by Redocly

Authentication API (v2.1.6)

Download OpenAPI specification:Download

E-mail: support@voicetel.com License: Apache 2.0

Authentication Method

Authentication

Account authentication-mode endpoints.

List Authentication Settings

Returns the current authentication type and IP ACL entries for the authenticated account. Optionally includes authentication type descriptions and authorized SIP endpoints.

Authorizations:
apikey
Request Body schema: application/json
required

Body for list authentication settings.

apikey
required
string
instructions
boolean

When true, includes a description for each authType value in the response.

authorizedEndpoints
boolean

When true, includes the list of authorized SIP endpoint hostnames in the response.

Responses

Request samples

Content type
application/json
{
  • "apikey": "Your API Key",
  • "instructions": true,
  • "authorizedEndpoints": true
}

Response samples

Content type
application/json
{
  • "account": {
    },
  • "statusCode": "200",
  • "status": "Success"
}

Update Authentication Settings

Updates the account authentication type and/or password. At least one of authType or password must be provided. Returns per-field success or conflict status.

Authorizations:
apikey
Request Body schema: application/json
required

Body for update authentication settings.

apikey
required
string
password
string

New password. Must be 6-10 alphanumeric characters and contain at least one letter and one number.

authType
integer
Enum: 0 1 2 3

Authentication type to set. 0=Digest, 1=IP Auth, 2=Digest OR IP Auth, 3=Digest AND IP Auth.

Responses

Request samples

Content type
application/json
{
  • "apikey": "Your API Key",
  • "password": "abc123",
  • "authType": 1
}

Response samples

Content type
application/json
{
  • "update": [ ],
  • "statusCode": "200",
  • "status": "Success"
}