Skip to content

Commit 6fa8d7c

Browse files
Merge pull request #277633 from vac0224/vc-trouble-pstn-call-failures-2024-06-07
New PSTN troubleshooting
2 parents ea3bdf1 + 5cc6282 commit 6fa8d7c

File tree

16 files changed

+724
-309
lines changed

16 files changed

+724
-309
lines changed

articles/communication-services/concepts/analytics/logs/voice-and-video-logs.md

Lines changed: 113 additions & 113 deletions
Large diffs are not rendered by default.
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Troubleshooting call end response codes for Call Automation SDK
3+
description: include file
4+
services: azure-communication-services
5+
author: slpavkov
6+
manager: aakanmu
7+
8+
ms.service: azure-communication-services
9+
ms.subservice: azure-communication-services
10+
ms.date: 7/22/2024
11+
ms.topic: include
12+
ms.custom: include file
13+
ms.author: slpavkov
14+
---
15+
## Call Automation SDK error codes
16+
17+
The following error codes are exposed by the Call Automation SDK.
18+
19+
| SubCode | Code | Message | Result Categories | Advice |
20+
|--- |--- |--- |--- |--- |
21+
| | 400 | Bad request | | The input request is invalid. Look at the error message to determine which input is incorrect. |
22+
| | 400 | Play Failed | | Ensure your audio file is WAV, 16 KHz, or Mono, and make sure the file URL is publicly accessible. |
23+
| | 400 | Recognize Failed | | Check the error message. The message highlights if this failure is due to timeout being reached or if operation was canceled. For more information about the error codes and messages, see [gathering user input](../../../how-tos/call-automation/recognize-action.md#event-codes). |
24+
| | 401 | Unauthorized | | HMAC authentication failed. Verify whether the connection string used to create CallAutomationClient is correct. |
25+
| | 403 | Forbidden | | Request is forbidden. Make sure that you can have access to the resource you're trying to access. |
26+
| | 404 | Resource not found | | The call you're trying to act on doesn't exist. For example, transferring a call that previously disconnected. |
27+
| | 429 | Too many requests | | Retry after a delay suggested in the Retry-After header, then exponentially backoff. |
28+
| | 500 | Internal server error | | Retry after a delay. If it persists, raise a support ticket. |
29+
| | 500 | Play Failed | | File a support request through the Azure portal. |
30+
| | 500 | Recognize Failed | | Check error message and confirm the audio file format is valid (WAV, 16 KHz, Mono). If the file format is valid, file a support request through Azure portal. |
31+
| | 502 | Bad gateway | | Retry after a delay with a fresh http client. |
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
title: Troubleshooting Calling End codes and subcodes
3+
description: include file
4+
services: azure-communication-services
5+
author: slpavkov
6+
manager: aakanmu
7+
8+
ms.service: azure-communication-services
9+
ms.subservice: azure-communication-services
10+
ms.date: 7/22/2024
11+
ms.topic: include
12+
ms.custom: include file
13+
ms.author: slpavkov
14+
---
15+
16+
## Understanding calling codes and subcodes errors
17+
18+
Error codes, subcodes, and corresponding result categories help developers identify and diagnose errors. These error codes are exposed through the `call.callEndReason` property after a call ends.
19+
20+
Error code details include:
21+
22+
**Code** - are 3 digit integers representing client or server response status. The code categories:
23+
24+
- Successful responses (**200-299**)
25+
- Client error (**400-499**)
26+
- Server error (**500-599**)
27+
- Global error (**600-699**)
28+
29+
**Subcode** - Are defined as an integer, where each number indicates a unique reason, specific to a group of scenarios or specific scenario outcome.
30+
31+
**Message** - Describes the outcome, and provides hints how to mitigate the problem if an outcome is a failure.
32+
33+
**ResultCategory** - Indicates the type of the error. Depending on the context, the value can be `Success`, `ExpectedError`, `UnexpectedClientError`, or `UnexpectedServerError`.
34+
35+
## Calling End call codes and subcodes
36+
37+
There are different explanations for why a call ended. Here are the meanings of the end of call codes and subcodes that show how a call can end.
38+
39+
| Subcode | Code | Message | Result Categories | Advice |
40+
|--- |--- |--- |--- |--- |
41+
| 0 | 0 | Call ended successfully by local participant. | Success | |
42+
| 0 | 487 | Call ended successfully as caller canceled the call. | Success | |
43+
| 0 | 603 | Call ended successfully as it was declined from callee. | Success | |
44+
| 4097 | 0 | Call ended for all users by the meeting organizer. | Success | |
45+
| 4507 | 495 | Call ended as application didn't provide valid Azure Communication Services token. | UnexpectedClientError | Ensure that your application implements token refresh mechanism correctly. |
46+
| 5000 | 0 | Call ended for this participant. Participant removed from the conversation by another participant. | Success | |
47+
| 5003 | 0 | Call ended successfully, as all callee endpoints declined the call. | Success | |
48+
| 5300 | 0 | Call ended for this participant. Participant removed from the conversation by another participant. | Success | |
49+
| 7000 | 0 | Call ended by Azure Communication Services platform. | Success | |
50+
| 10003 | 487 | Call was accepted elsewhere, by another endpoint of this user. | Success | |
51+
| 10004 | 487 | Call was canceled on timeout, no callee endpoint accepted on time. Ensure that user saw the notification and try to initiate that call again. | ExpectedError | |
52+
| 10024 | 487 | Call ended successfully. Call declined by all callee endpoints. | Success | - Try to place the call again. |
53+
| 301005 | 410 | Participant removed from the call by the Azure Communication Services infrastructure due to loss of media connectivity with the same infrastructure. This usually happens if participant leaves the call abruptly or loses network connectivity. If the participant wants to continue the call, they can reconnect. | UnexpectedClientError | Ensure that you're using the latest SDK in a supported environment. |
54+
| 510403 | 403 | Call ended, previously marked as a spam and now blocked. | ExpectedError | - Ensure that your Communication Services token is valid and not expired. <br /> - Ensure to pass in `AlternateId` in the call options. |
55+
| 540487 | 487 | Call ended successfully as caller canceled the call. | Success | |
56+
| 560000 | 0 | Call ended successfully by remote PSTN participant. | Success |Possible causes: <br /> - User ended the call. <br /> - Call ended by media agent. |
57+
| 560486 | 486 | Call ended because remote PSTN participant was busy. The number called was already in a call or having technical issues. |
58+
| | 404 | Call not found. | | Ensure that the number you're calling (or call you're joining) exists. |
59+
| | 408 | Call controller timed out. | | Call Controller timed out waiting for protocol messages from user endpoints. Ensure clients are connected and available. |
60+
| | 410 | Local media stack or media infrastructure error. | | Ensure that you're using the latest SDK in a supported environment. |
61+
| | 430 | Unable to deliver message to client application. | | Ensure that the client application is running and available. |
62+
| | 480 | Remote client endpoint not registered. | | Ensure that the remote endpoint is available. |
63+
| | 481 | Failed to handle incoming call. | | File a support request through the Azure portal. |
64+
| | 490, 491, 496, 497, 498 | Local endpoint network issues. | | Check your network. |
65+
| | 500, 503, 504 | Communication Services infrastructure error. | | File a support request through the Azure portal. |

0 commit comments

Comments
 (0)