Skip to content

Commit 0f9083a

Browse files
vac0224vac0224
committed
Updated codes
Pivot table added
1 parent 607928d commit 0f9083a

File tree

8 files changed

+227
-167
lines changed

8 files changed

+227
-167
lines changed

‎articles/communication-services/concepts/includes/codes/call-automation-sdk.md

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. |

‎articles/communication-services/concepts/includes/codes/calling-sdk.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: Troubleshooting call end response codes for Calling 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+
# Calling SDK error codes
16+
17+
The Azure Communication Services Calling SDK uses the following error codes to help you troubleshoot calling issues. These error codes are exposed through the `call.callEndReason` property after a call ends.
18+
19+
| SubCode | Code | Message | Result Categories | Advice |
20+
|--- |--- |--- |--- |--- |
21+
| | 403 | Forbidden / Authentication failure. | | Ensure that your Communication Services token is valid and not expired. |
22+
| | 404 | Call not found. | | Ensure that the number you're calling (or call you're joining) exists. |
23+
| | 408 | Call controller timed out. | | Call Controller timed out waiting for protocol messages from user endpoints. Ensure clients are connected and available. |
24+
| | 410 | Local media stack or media infrastructure error. | | Ensure that you're using the latest SDK in a supported environment. |
25+
| | 430 | Unable to deliver message to client application. | | Ensure that the client application is running and available. |
26+
| | 480 | Remote client endpoint not registered. | | Ensure that the remote endpoint is available. |
27+
| | 481 | Failed to handle incoming call. | | File a support request through the Azure portal. |
28+
| | 487 | Call canceled, locally declined, ended due to an endpoint mismatch issue, or failed to generate media offer. | | Expected behavior. |
29+
| | 490, 491, 496, 497, 498 | Local endpoint network issues. | | Check your network. |
30+
| | 500, 503, 504 | Communication Services infrastructure error. | | File a support request through the Azure portal. |
31+
| | 603 | Call globally declined by remote Communication Services participant. | | Expected behavior. |
32+

‎articles/communication-services/concepts/includes/codes/chat-sdk.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: Troubleshooting response codes for Chat 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+
# Chat SDK error codes
16+
17+
The Chat SDK uses the following error codes to help you troubleshoot chat issues. The error codes are exposed through the `error.code` property in the error response.
18+
19+
| Code | Message | Advice |
20+
| --- | --- | --- |
21+
| 401 | Unauthorized | Ensure that your Communication Services token is valid and not expired. |
22+
| 403 | Forbidden | Ensure that the initiator of the request has access to the resource. |
23+
| 429 | Too many requests | Ensure that your client-side application handles this scenario in a user-friendly manner. If the error persists, file a support request. |
24+
| 503 | Service Unavailable | File a support request through the Azure portal. |

‎articles/communication-services/concepts/includes/codes/pstn.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
title: Troubleshooting call end response codes for PSTN calling
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+
# PSTN call response codes with ParticipantEndReason
16+
17+
This section provides troubleshooting information for various combinations of `ParticipantEndReason` and `ParticipantEndSubCode` response codes. For the tables in this section, `ParticipantEndReason` = **Code** and `ParticipantEndSubCode` = **SubCode**.
18+
19+
## ParticipantEndReason 0
20+
21+
Response `ParticipantEndReason` with value 0 usually means normal call clearing and marks calls that completed without errors.
22+
23+
| SubCode | Code | Message | Result Categories | Advice |
24+
|--- |--- |--- |--- |--- |
25+
| 0 | 0 | Call ended successfully by local participant. | Success | |
26+
| 560000 | 0 | Normal PSTN call end:<br/> - User ended the call.<br/> - Call ended by media agent. | Success | |
27+
| 540000 | 0 | Normal PSTN call end:<br/> - User ended the call.<br/> - Call ended by media agent. | Success | |
28+
29+
30+
## ParticipantEndReason 4xx
31+
32+
Response `ParticipantEndReason` with value 4xx means that the call didn't connect.
33+
34+
| SubCode | Code | Message | Result Categories | Advice |
35+
|--- |--- |--- |--- |--- |
36+
| 510403 | 403 | Call blocked:<br/> - Alternate ID not supplied for the call.<br/> - Phone number not allowed by users Session Border Controller (SBC). | | - For more information about Alternate ID, see [Manage calls](../../../how-tos/calling-sdk/manage-calls.md#place-a-call).<br/> - Make sure that you specified a valid Alternate ID. It must be a phone number that belongs to the Resource you're using.<br/> - Verify that you own the Resource you're using to make a call.<br/> - For direct routing calls, verify why your Session Border Controller disallowed the call. |
37+
| 560403 | 403 | - Call forbidden.<br/> - Call canceled.<br/> - Call rejected. | | Make sure that you called a valid phone number in the correct format. For more information about supported number formats, see <https://en.wikipedia.org/wiki/E.164>. |
38+
| 511532 | 403 | Resource SIP trunk configuration not found. | | Check your direct routing setup in the [Azure portal](https://portal.azure.com). For more information, see [Direct routing provisioning](../../../concepts/telephony/direct-routing-provisioning.md). |
39+
| 560404 | 404 | - Phone number not found.<br/> - Phone number not assigned to any target.<br/> - Phone number not allowed by Session Border Controller. | | - Make sure the phone number belongs to the Resource you're using and that you own the Resource.<br/> - Verify that the number you're calling exists, and is assigned to valid target. |
40+
| 511404 | 404 | - Phone number not found.<br/> - Resource used in the call not found. | | - Make sure you used a phone number that belongs to the Resource you're using and that you own the Resource.<br/> - Verify that the number you're calling exists, and is assigned to a valid target.<br/> - Make sure that the Resource you're using for the call isn't deleted or disabled.<br/> - Make sure your Azure subscriptions isn't deleted or disabled. |
41+
| 560408 | 408 | The called party didn't respond to a call establishment message within the prescribed time period. | | - Double check why the called party didn't respond.<br/> - For direct routing calls, check your Session Border Control logs and settings and timeouts configuration. |
42+
| 500001 | 408 | User gateway timeout<br/>Azure Communication Services didn't receive a response from the client within a specified time limit and terminated the request. | | - Double check why the called party didn't respond.<br/> - For direct routing calls, check your Session Border Control logs and settings and timeouts configuration. |
43+
| 531004 | 410 | Interactive Connectivity Establishment (ICE) checks failed. | | - The media path couldn't be established. Can be caused by incorrect network configuration. Verify your network configuration to make sure that the required IP addresses and ports aren't blocked. Read the guidelines in <https://www.rfc-editor.org/rfc/rfc5245#section-7>.<br/> - For direct routing calls, check your Session Border Control logs and settings for ICE configuration and profile. Contact your SBC vendor for configuration help. For more information, see [List of Session Border Controllers certified for Azure Communication Services direct routing](../../../concepts/telephony/certified-session-border-controllers.md). |
44+
| 560480 | 480 | - No answer from the called user.<br/> - Called user temporary unavailable. | | - Double check why the called party didn't respond.<br/> - Retry the call later in case that the called party was temporary unavailable.<br/> - For direct routing calls, check your Session Border Control logs and settings and timeouts configuration. |
45+
| 560484 | 484 | - Incomplete or invalid callee address.<br/> - Incomplete or invalid callee number format. | | - In some cases, you can ignore these failures because the user is dialing an invalid number.<br/> - Make sure the phone numbers are formatted correctly. For more information, see <https://en.wikipedia.org/wiki/E.164>.<br/> - For direct routing, the SBC could cause these failures because of a missing configuration in a call transfer scenario. |
46+
| 60486 | 486 | The called number was busy | | - The called number may be connected to an existing call, or having a technical problem.<br/> - For direct routing calls, check your Session Border Control logs and settings and timeouts configuration. |
47+
| 540487 | 487 | The caller terminated the call request. | | Retry the call. |
48+
| 560487 | 497 | - The caller terminated the call request.<br/> - Request terminated with normal call clearing. | | Retry the call. |
49+
50+
51+
## ParticipantEndReason 5xx
52+
53+
Response `ParticipantEndReason` with value 5xx means that the call failed due to a problem with a software or hardware component required to complete the connection.
54+
55+
| SubCode | Code | Message | Result Categories | Advice |
56+
|--- |--- |--- |--- |--- |
57+
| 560500 | 500 | An internal server error occurred in one of the services involved in the call. | | - Retry the call. If the issue persists contact your telco provider or Microsoft support.<br/> - For direct routing calls, check your Session Border Control logs and settings and timeouts configuration, to see if your SBC caused the failure. |
58+
| 560503 | 503 | - Call failed because of an internal server error in one of the services involved in the call.<br/> - The network used to establish the call is out of order.<br/> - A temporary failure in one of the services involved in the call. | | - Check your network and routing configuration for possible issues. Verify that your network firewall rules are correct.<br/> - Retry the call. If the issue persist contact your telco provider or Microsoft support.<br/> - For direct routing calls, check your Session Border Control logs and settings and timeouts configuration, to see if your SBC caused the failure. |
59+
60+
61+
## ParticipantEndReason 603
62+
63+
Response `ParticipantEndReason` with value 603 means that the call was rejected without connecting.
64+
65+
| SubCode | Code | Message | Result Categories | Advice |
66+
|--- |--- |--- |--- |--- |
67+
| 560603 | 603 | - Call declined by the recipient.<br/> - Call declined due to fraud detection. | | - If declined by the recipient, retry the call.<br/> - Ensure that you aren't exceeding the maximum number of concurrent calls allowed for your Azure Communication Services phone number. For more information, see [PSTN call limitations](../concepts/service-limits.md#pstn-call-limitations). |

‎articles/communication-services/concepts/includes/codes/sms-sdk.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Troubleshooting response codes for SMS
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+
# SMS error codes
16+
17+
The SMS SDK uses the following error codes to help you troubleshoot SMS issues. The error codes are exposed through the `DeliveryStatusDetails` field in the SMS delivery report.
18+
19+
| Code | Message | Advice |
20+
| --- | --- | --- |
21+
| 2000 | Message Delivered Successfully. | |
22+
| 4000 | Message is rejected due to fraud detection. | Ensure you aren't exceeding the maximum number of messages allowed for your number. |
23+
| 4001 | Message is rejected due to invalid Source/From number format| Ensure the To number is in E.164 format and From number format is in E.164 or Short code format. |
24+
| 4002 | Message is rejected due to invalid Destination/To number format. | Ensure the To number is in E.164 format |
25+
| 4003 | Message failed to deliver due to unsupported destination. | Check if the destination you're trying to send to is supported. |
26+
| 4004 | Message failed to deliver since Destination/To number doesn't exist. | Ensure the To number you're sending to is valid. |
27+
| 4005 | Message is blocked by Destination carrier. | |
28+
| 4006 | The Destination/To number isn't reachable. | Try resending the message at a later time. |
29+
| 4007 | The Destination/To number has opted out of receiving messages from you. | Mark the Destination/To number as opted out so that no further message attempts are made to the number. |
30+
| 4008 | You've exceeded the maximum number of messages allowed for your profile. | Ensure you aren't exceeding the maximum number of messages allowed for your number or use queues to batch the messages. |
31+
| 4009 | Message is rejected by Microsoft Entitlement System. | Most often this happens if fraudulent activity is detected. Contact support for more details. |
32+
| 4010 | Message was blocked due to the toll-free number not being verified. | [Review unverified sending limits](../../sms/sms-faq.md#toll-free-verification) and submit toll-free verification as soon as possible. |
33+
| 5000 | Message failed to deliver. Reach out Microsoft support team for more details. | File a support request through the Azure portal. |
34+
| 5001 | Message failed to deliver due to temporary unavailability of application/system. | |
35+
| 5002 | Carrier does not support delivery report | Most often this happens if a carrier does not support delivery reports. No action required as message may have been delivered already. |
36+
| 9999 | Message failed to deliver due to unknown error/failure. | Try resending the message. |

0 commit comments

Comments
 (0)