CPaaS Reason Codes Dictionary

CPaaS will provide a reason code along with a short description for failed or blocked session attempts, such as voice or sms sessions.

Reason code and the relevant description will be provided in either SIP or HTTP response.

Reason codes 0 - 999 are reserved for network specific error codes from network protocols such as SIP, HTTP, MGCP etc.

Reason Code Families

Code family	Description
1xxx	CPaaS generic errors
11xx	CPaaS call errors
2xxx	CPaaS RCML Generic errors
21xx	CPaaS RCML Gather verb errors
22xx	CPaaS RCML Dial verb errors
23xx	CPaaS RCML Say verb errors
24xx	CPaaS RCML Reject verb errors
3xxx	CPaaS provisioning generic error
31xx	CPaaS number provisioning error
32xx	CPaaS client provisioning error
33xx	CPaaS account provisioning error
4xxx	CPaaS Media Gateway error
5xxx	CPaaS extension error
30xxx	CPaaS SMS messaging error

Code family

Description

1xxx

CPaaS generic errors

11xx

CPaaS call errors

2xxx

CPaaS RCML Generic errors

21xx

CPaaS RCML Gather verb errors

22xx

CPaaS RCML Dial verb errors

23xx

CPaaS RCML Say verb errors

24xx

CPaaS RCML Reject verb errors

3xxx

CPaaS provisioning generic error

31xx

CPaaS number provisioning error

32xx

CPaaS client provisioning error

33xx

CPaaS account provisioning error

4xxx

CPaaS Media Gateway error

5xxx

CPaaS extension error

30xxx

CPaaS SMS messaging error

CPaaS Specific Reason Codes

Code	Protocol	Text	Comment
1000	CPaaS	Internal Error	Reason code for any internal error that is not specified later
1001	CPaaS	Client Registration Expired	CPaaS client registration expired
1002	CPaaS	Feature Not Supported (feature name)	Use of feature not allowed for the given account. TODO check if more features/extension reason codes are needed and change family
1100	CPaaS	Call Not Found or Terminated (transferror/targetRef)	Transfer cannot be completed because the transferror side terminated or cannot be found (LCM or Transfer)
1101	CPaaS	Call Terminated	Update request to terminate Call completed successfully
1102	CPaaS	Call Canceled	Update request to cancel Call completed successfully
1103	CPaaS	Invalid Call State	Call state was not in the expected state during a call operation such LCM, Transfer etc.
1104	CPaaS	Call Maximum Duration Exceeded	Call maximum duration exceeded
1105	CPaaS	Call No Answer	Timeout waiting for answer
2000	CPaaS	Generic RCML Error	Something was wrong during RCML parsing
2001	CPaaS	RCML Validation failure	RCML document validation against rcml.xsd failed
2100	CPaaS	Gather verb invalid hints	Gather verb HotWords limit exceeded or hint length greater than 100
2200	CPaaS	Dial verb - conference max time exceeded	Maximum time of conference exceeded
2201	CPaaS	Dial verb - conference not found or completed	conference not found or completed
2300	CPaaS	Say verb error	Generic Say verb error
2301	CPaaS	Say verb - no TTS providers available	TTS providers not available
2302	CPaaS	Say verb - unknown provider	Unknown TTS provider requested
2303	CPaaS	Say verb - invalid language	Invalid TTS language requested
2400	CPaaS	Reject verb	CPaaS Reject verb
3000	CPaaS	Generic Provision error	Something was wrong with the Provision data
3100	CPaaS	Number Provision error	Number Provision data error
3101	CPaaS	Number not found	Number not found
3102	CPaaS	Number not bound (Context)	Number doesn’t point to an application, either by RCML URL or Application SID. Context could be any of: Voice, Sms, Refer, REST API Call.
3200	CPaaS	Application provision error	Application provision error
3201	CPaaS	Application not found	Application not found
3301	CPaaS	Account not active	CPaaS Account not active
4000	CPaaS	CPaaS Media Gateway error	Generic Media Gateway error
4100	CPaaS	CPaaS Media Operation failed	CPaaS Media Operation failed
5000	CPaaS	Extension Error	CPaaS Extension Error
5001	CPaaS	Extension Blocked Session	Session was not allowed by an extension
30001	CPaaS	Message Queue overflow	Message failed

Code

Protocol

Text

Comment

1000

CPaaS

Internal Error

Reason code for any internal error that is not specified later

1001

CPaaS

Client Registration Expired

CPaaS client registration expired

1002

CPaaS

Feature Not Supported (feature name)

Use of feature not allowed for the given account. TODO check if more features/extension reason codes are needed and change family

1100

CPaaS

Call Not Found or Terminated (transferror/targetRef)

Transfer cannot be completed because the transferror side terminated or cannot be found (LCM or Transfer)

1101

CPaaS

Call Terminated

Update request to terminate Call completed successfully

1102

CPaaS

Call Canceled

Update request to cancel Call completed successfully

1103

CPaaS

Invalid Call State

Call state was not in the expected state during a call operation such LCM, Transfer etc.

1104

CPaaS

Call Maximum Duration Exceeded

Call maximum duration exceeded

1105

CPaaS

Call No Answer

Timeout waiting for answer

2000

CPaaS

Generic RCML Error

Something was wrong during RCML parsing

2001

CPaaS

RCML Validation failure

RCML document validation against rcml.xsd failed

2100

CPaaS

Gather verb invalid hints

Gather verb HotWords limit exceeded or hint length greater than 100

2200

CPaaS

Dial verb - conference max time exceeded

Maximum time of conference exceeded

2201

CPaaS

Dial verb - conference not found or completed

conference not found or completed

2300

CPaaS

Say verb error

Generic Say verb error

2301

CPaaS

Say verb - no TTS providers available

TTS providers not available

2302

CPaaS

Say verb - unknown provider

Unknown TTS provider requested

2303

CPaaS

Say verb - invalid language

Invalid TTS language requested

2400

CPaaS

Reject verb

CPaaS Reject verb

3000

CPaaS

Generic Provision error

Something was wrong with the Provision data

3100

CPaaS

Number Provision error

Number Provision data error

3101

CPaaS

Number not found

3102

CPaaS

Number not bound (Context)

Number doesn’t point to an application, either by RCML URL or Application SID. Context could be any of: Voice, Sms, Refer, REST API Call.

3200

CPaaS

Application provision error

3201

CPaaS

Application not found

3301

CPaaS

Account not active

CPaaS Account not active

4000

CPaaS

CPaaS Media Gateway error

Generic Media Gateway error

4100

CPaaS

CPaaS Media Operation failed

5000

CPaaS

Extension Error

CPaaS Extension Error

5001

CPaaS

Extension Blocked Session

Session was not allowed by an extension

30001

CPaaS

Message Queue overflow

Message failed