API Status Codes

API status codes for Messaging, Transaction Status, Events, and Profile API.

The APIs will respond with a code to in a synchronous response to the request

Messaging

CodeMessageDescription
7000Invalid JSONReturned when an invalid JSON request is sent.
7001Authentication failedReturned when an invalid service key or profile key is provided in the request.
7002Service Key MissingReturned when the parameter key is missing in the message request.
7003any one of [customerid,msisdn,email, userid,pushid,psid, etc.] is mandatoryReturned when a mandatory parameter is missing for destination.
param 'text' is missing for androidReturned when parameter text or its value is missing for Android in push object.
param 'text' is missing for iosReturned when the parameter text or its value is missing for iOS in push object.
param 'push' missing for push channelReturned when the parameter push is missing.
either android or ios information is mandatory for push channelReturned when the push channel is missing in push object.
param 'text' missing for channel fbReturned when the parameter text or its value is missing for Facebook channel.
param 'OTT-Messaging' missing for channel fbReturned when the OTT-Messaging object is missing when deliverychannel is Facebook.
param 'fb' missing for channel fbReturned when the fb object is missing in OTT-Messaging object.
param 'text' missing for channel rtReturned when the parameter text or its value is missing for rt channel.
param 'appmessaging' missing for channel rtReturned when the rt object is missing when deliverychannel is rt.
param 'body' missing for channel smsReturned when the parameter body or its value is missing for sms channel and the parameter type is not selected as text (1).
param 'text' missing for channel smsReturned when the parameter text or its value is missing for sms channel.
param 'sms' missing for channel smsReturned when the sms object is missing when deliverychannel is sms.
either param 'callflowid' or param 'media' is requiredReturned when the parameters callflowid or media or their values are missing for voice channel.
param 'voice' missing for channel voiceReturned when the voice object is missing when deliverychannel is voice.
No destination channel information found in requestReturned when the value is missing for deliverychannel.
param 'deliverychannel' missingReturned when the deliverychannel is missing.
mandatory param device_types missingReturned when devicetypes object is missing in _interactive object.
mandatory param value missing for action xxxReturned when the parameter value is missing in actions array.
mandatory param pos missingReturned when the parameter pos is missing in actions array.
mandatory param category missingReturned when the parameter category is missing in interactive object.
mandatory param actions missingReturned when the parameter actions is missing in interactive object.
7004invalid value for param 'priority', it should be one of [1,2,3,4,5]Returned when the parameter priority value is other than 1 to 5 for rt channel.
invalid value of param 'type' , only [1,2,3,4] are allowedReturned when the parameter type value is other than 1 to 4 for sms channel.
invalid device type xxx, only ios or android is allowedReturned when the parameter device_types value is other than ios or android.
duplicate device type xxxReturned when duplicate position value is provided in device_types array in interactive object.
invalid value of param pos, duplicate values for pos are not allowedReturned when duplicate position value is provided in actions array in interactive object.
invalid value of param action or action is invalid for this channelReturned when an invalid action is provided in actions array in interactive object.
invalid value of param value, specified value is invalid for action xxxReturned when an invalid value is provided in value parameter in interactive actions object.
invalid action for identifier xxxReturned when an invalid action is provided for corresponding category.
invalid identifier or no actions mapped for this identifierReturned when the corresponding identifiers for category are not mapped to the identifiers that are there for actions.
no identifier found for this category and at this positionReturned when identifiers are not found for a category.
Invalid value of param pos, only positions [xx,xx] are allowed for this categoryReturned when an invalid position value is provided that is not there for corresponding category.
Invalid number of actions, expected actions size xx, but found xxReturned when an unexpected number of actions found in interactive object.
Invalid value of param category or no identifiers mapped to this categoryReturned when an invalid category is provided in request.
7005Request expiredReturned when the request is expired.
7006Internal error occurredReturned when an internal error occurs.
Internal server errorReturned when an occur occurs in server.
7007Service InactiveReturned when a service is in inactive state.
7008Inactive ProfileReturned when the profile is inactive.
7009Maximum number of destination addressReturned when an API request exceeds the limit (1000) to send messages using messaging API.
7010Source IP is not in the allowed listReturned when a request is sent from an IP that is not in the allowed list in Webex Connect.
Service provider exceptionReturned when a service provider exception occurs.
7011Unknown ExceptionReturned when an unknown exception occurs.
7019Request expiredReturned when the request is expired.
7020You have reached maximum transaction limitReturned when you have reached the transaction limit.
7101Invalid Sender IDReturned when the sender ID is invalid.
7102Invalid addressReturned when the address is invalid.
7103Not enough creditsReturned when the client does not have enough credits in his account.
7104Invalid app idReturned when the app id is invalid.
7105Customer profile not foundReturned when the customer profile is not found.
7106Channel not configuredReturned when the channel is not configured.
7107Message length exceededReturned when the length of the message exceeded.
7108Invalid templateReturned when the template is invalid.
7109User in DnDReturned when the user is registered on Do Not Disturb list.
7110User is not activeReturned when the user is in inactive state.
7111Spam content detectedReturned when the content contains a spam word.
7112Invalid message typeReturned when the message type is invalid.
7113Social hoursReturned when the message is sent during non-social hours.
7114Configuration Error. Please contact admin.Returned when there is an error in configuration.
7115Rate plan not definedReturned when the rate plan is not defined.
7116Destination profile is not verifiedReturned when the destination profile is not verified.
7117RTM is not enabled for this appReturned when RTM is not enabled for this application.
7118push is not enabled for this appReturned when push is not enabled for this application.
7119Destination profile doesn't have OS detailsReturned when the destination profile does not have OS details.
7120Voice params length exceededReturned when the voice parameters length is exceeded.
7121Replaceable params could not be fetched.Returned when the replaceable parameters could not be fetched.
7200Unknown StatusReturned when the status is unknown.
7201Delivery failed at OperatorReturned when the delivery failed at operator.
7202Delivery failed at platformReturned when the delivery failed at platform.
7203Unknown Subscriber addressReturned when the subscriber address is not known.
7204Insufficient Credits in subscriber accountReturned when the subscriber account has insufficient credits.
7205Error in Binary messageReturned when there is an error in binary message.
7206Can't deliver. Subscriber SIM FullReturned when the subscribers sim is full.
7207Subscriber out of coverage area or not reachableReturned when the subscriber is out of coverage area.
7208Source ip is not in the allowed listReturned when the source IP is not in the allowed list.
7208Message expiredReturned when message is expired.
7209Unable to deliver multipart messageReturned when unable to deliver multipart message.
7210Billing Configuration errorReturned when there is an error in billing configuration.
7211Billing error at operatorReturned when an error occurs at operator.
7212Invalid registrationReturned when the registration is invalid.
7213UnregisteredReturned when the user is not registered.
7214Cloud specific failureReturned due to cloud failure.
7301Message expiredReturned when the message is expired.
7302Rate limit exceededReturned when the rate limit exceeded.
7303Delivery notification of a message expiredReturned when the delivery notification of a message is expired.
7304Invalid app credentials(Invalid OAuth)Returned when invalid app credentials are provided.
7305Invalid user credentialsReturned when user credentials are invalid.
7307End point not reachable(FB is not reachable)Returned when Facebook is not reachable.
7401No answerReturned when the call is not answered.
7402Customer busyReturned when the customer is busy.
7403Call rejectedReturned when the call is rejected.
7404OthersReturned for other errors
7500DeliveredReturned when the delivery is completed successfully.
7501SubmittedReturned when the submit is success.
7502ReadReturned when the message is read.
7503Message expired before delivery attemptReturned when the message is expired before attempting a delivery.
7504Authentication errorReturned when an authentication error occurs.
7505Too large payload ( >4kb)Returned when the payload is more than 4kb for Android.
7506Invalid time to live valueReturned when an invalid value is passed for time to live parameter for Android.
7507Too many requests for the AppReturned when too many requests are received for the same app.
7508GCM server errorReturned when an error occurs in Google Cloud Messaging server.
7509Too many concurrent requests for same customerReturned when too many requests are received for the same customer.
7510Too big payloadReturned when the payload is more than 4kb for iOS.
7511Invalid time to live valueReturned when an invalid value is passed for time to live parameter for iOS.
7512Invalid push idReturned when the push id is invalid.
7513Unregistered DeviceReturned when a device is not registered.
7514Wrong apns certificate gatewayReturned when a wrong APNs certificate is provided.
7515Bad apns certificateReturned when an APNs certificate is invalid.
7516Too many request for the same deviceReturned when too many requests are received by the same device.
7517APNS server errorReturned when an APNs server error occurs.
7518UnknownReturned when an unknown error occurs.
7600no results foundReturned when the results are not found.
7601transaction is not under this service or service key is invalidReturned when there is a mismatch with the service key or transaction.
7601Verification failedReturns then the verification is failed.
7602user presence failureReturned when the user not available in the network.
7603either validation failed for request or user verification failureReturned when the validation is failed or user verification is failed for the request.
7618Invalid request characters: The character uxxxx cannot be includedReturned when the message format is invalid.
7627Parameter missing: media idReturned when the message is sent without media id parameter.
7628The other user is not yet a followerReturned when the message is sent to a non follower.
7629The other user is not yet a followerReturned when the message is sent to a non follower.
7630Rich media message is emptyReturned when the message is sent without rich media.
7631Text message is emptyReturned when the message is sent without a text.
7632Error source: multimedia file sizeReturned when the media size is beyond the expected size.
7633Message contents too longReturned when the message is sent with a lengthy text.
7634Title too longReturned when the message title is too long.
7635Description too longReturned when the description is too long.
7636URL too longReturned when the URL is too long.
7637Image URL too longReturned when the Image URL is too long.
7638Audio play time over limitReturned when the audio play time exceeds 60 seconds.
7639Rich media messages over limitReturned when you have used up your limit to send Rich media messages.
7641Message quantity over limitReturned when you have used up your limit to send messages.
7642This user does not exist.Returned when the message is sent with an invalid user information.
7643Invalid image file type (invalid file type)Returned when the image file type is invalid.

Transaction Status

CodeMessageDescription
7006Internal server errorReturned when the message failed at the gateway and was not transmitted to the destination operator. This is may be an intermittent temporary error.
7008Inactive profileReturned when the profile is inactive.
7010Service provider exceptionReturned when a service provider exception occurs.
7011Unknown exceptionReturned when an unknown exception occurs.
7019Request expiredReturned when the request is expired.
7020You have reached maximum transaction limitReturned when you have reached the transaction limit.
7101Invalid Sender IDReturned when the sender is not authorized or configured at the destination operator or the wrong sender Id is being used for this request.
7102Invalid addressReturned when the address is invalid.
7103Not enough creditsReturned when the client does not have enough credits in his account.
7104Invalid app IDReturned when the app id is invalid.
7105Customer profile not foundReturned when the customer profile is not found.
7106Channel not configuredReturned when the channel is not configured.
7107Message length exceededReturned when the length of the message exceeded.
7108Invalid templateReturned when the template is invalid.
7109User in DnDReturned when the user is registered on Do Not Disturb list.
7110User is not activeReturned when the user is in inactive state.
7111Span content detectedReturned when the network operator has rejected this message as spam. Subsequent messages to the recipient may or may not be delivered depending on the underlying cause:
-The sender ID has exceeded or violated carrier rules on message velocity (too many messages to the same recipient, too many messages from the same sender ID with sender ID restrictions).
-The message content was marked as spam due to detected keywords.
-The message was flagged for linking to websites suspected of spam or fraud.
-The message content contained URL-shortening services that the network operator may have banned.
7112Invalid message typeReturned when the message type is invalid.
7113Social hoursReturned when the message is sent during non-social hours.
7114Configuration Error. Please contact adminReturned when there is an error in configuration.
7115Rate plan not definedReturned when the rate plan is not defined.
7116Destination profile is not verifiedReturned when the destination profile is not verified.
7117RTM is not enabled for this appReturned when RTM is not enabled for this application.
7118Push is not enabled for this appReturned when push is not enabled for this application.
7119Destination profile doesn't have OS detailsReturned when the destination profile does not have OS details.
7120Voice parameters length exceededReturned when the voice parameters length is exceeded.
7121Replaceable parameters could not be fetched.Returned when the replaceable parameters could not be fetched.
7200Unknown statusReturned when the status is unknown.
7201Delivery failed at OperatorReturned when the message was routed to the operator but was rejected for various network-specific reasons (temp. failure or other network related issue).
7202Delivery failed at platformReturned when the delivery failed at platform.
7203Unknown Subscriber addressReturned when the number is an invalid mobile number on the destination network. This may indicate the subscriber is no longer valid, the number has ported away, or may have service blocks preventing message delivery.
7204Insufficient Credits in subscriber accountReturned when a message is sent to a prepaid mobile subscriber who no longer has a credit balance on their SIM card and can no longer receive messages.
7205Error in Binary messageReturned when there is an error in binary message.
7206Can't deliver. Subscriber SIM FullReturned when the subscribers SIM is full.
7207Subscriber out of coverage area or not reachableReturned when the subscriber is out of coverage area.
7208Message expiredReturned when the message could not be delivered to the handset and exceeded its delivery time limit. This occurs when a subscriber has their handset turned off, or handset has no more memory to accept messages.
7209Unable to deliver multi-part messageReturned when the message was sent as a multi-part message (either a long text message more than 160 chars which is split into multiple parts, or a message with specific character encoding) to the network destination and one or more of the parts was returned undeliverable. The specific error for the non-delivery is not disclosed and all parts of the message will be flagged with this error code.
7210Billing Configuration errorReturned when there is an error in billing configuration. This may be caused by an unexpected network destination, or due to a provisioning error.
7211Billing error at operatorReturned when message could not be delivered as network operator has indicated there was a billing related error.
7212Invalid registrationReturned when the registration is invalid.
7213UnregisteredReturned when the user is not registered.
7214Cloud specific failureReturned due to cloud failure.
7301Message expiredReturned when the message is expired.
7302Rate limit exceededReturned when the sender ID used to send traffic has exceeded its authorized TPS limit. 10 DLC registered numbers which are subject to rate limits will return such errors when exceeding the limits associated with their approved campaign IDs. The limits may be network operator, campaign or sender ID related. There could also be other throughput restrictions.

Please note that campaign and brand limits apply across service providers and are shared by the brand and/or campaign – ensure that when using multiple service providers, you are not exceeding the limits across those providers.
7303Delivery notification of a message expiredReturned when the delivery notification of a message is expired.
7304Invalid app credentials(Invalid OAuth)Returned when invalid app credentials are provided.
7305Invalid user credentialsReturned when user credentials are invalid.
7307End point not reachable (FB is not reachable)Returned when Facebook is not reachable
7401No answerReturned when the call is not answered.
7402Customer busyReturned when the customer is busy.
7403Call rejectedReturned when the call is rejected.
7404OthersReturned for other errors
7500DeliveredReturned when the message is transmitted to the destination network and confirmation of delivery is provided from the mobile handset.If the recipient did not receive the message, it may be due to spam, sender ID filters, or a corrupt or malformed message payload the handset was unable to process.
7501SubmittedReturned when the message has is in an interim status indicating submission to network provider, prior to it being actually delivered to the handset.
7502ReadReturned when the message is read.
7503Message expired before delivery attemptReturned when the message is expired before attempting a delivery.
7504Authentication errorReturned when an authentication error occurs.
7505Too large payload ( >4kb)Returned when the payload is more than 4kb for Android.
7506Invalid time to live valueReturned when an invalid value is passed for time to live parameter for Android.
7507Too many requests for the appReturned when too many requests are received for the same app.
7508GCM server errorReturned when an error occurs in Google Cloud Messaging server.
7509Too many concurrent requests for same customerReturned when too many requests are received for the same customer.
7510Too big payloadReturned when the payload is more than 4kb for iOS.
7511Invalid time to live valueReturned when an invalid value is passed for time to live parameter for iOS.
7512Invalid push IDReturned when the push ID is invalid.
7513Unregistered DeviceReturned when the device is unregistered
-The device inbox may be full at the device or network operator.
-The device has been marked as busy by the network operator.
-The device may have been flooded with messages and further submission to the device is not possible.
7514Wrong APNs certificate gatewayReturned when a wrong APNs certificate is provided.
7515Bad APNs certificateReturned when an APNs certificate is invalid.
7516Too many request for the same deviceReturned when too many requests are received by the same device.
7517APNs server errorReturned when an APNs server error occurs.
7518UnknownReturned when an unknown error occurs.
The message may or may not have been delivered, but no additional information is available from the network operator.
7600No results foundReturned when the results are not found.
7601Transaction is not under this service or service key is invalidReturned when there is a mismatch with the service key or transaction.
Verification failedReturns then the verification is failed
7602User presence failureReturned when the user not available in the network.
Either validation failed for request or user verification failureReturned when the validation is failed or user verification is failed for the request.
7608Invalid image file sizeReturned when the image file size exceeds the limit.
7609Invalid audio file sizeReturned when the audio file size exceeds 256K.
7610Invalid video file sizeReturned when the audio file size exceeds 1Mb.
7611Invalid thumbnail file sizeReturned when the thumbnail file size exceeds 64KB.
7618Invalid request characters: The character uxxxx cannot be includedReturned when the message format is invalid.
7627Parameter missing: media IDReturned when the message is sent without media id parameter.
7628The other user is not yet a followerReturned when the message is sent to a non follower.
7629The other user is not yet a followerReturned when the message is sent to a non follower.
7630Rich media message is emptyReturned when the message is sent without rich media.
7631Text message is emptyReturned when the message is sent without a text.
7632Error source: multimedia file sizeReturned when the media size is beyond the expected size.
7633Message contents too longReturned when the message is sent with a lengthy text.
7634Title too longReturned when the message title is too long.
7635Description too longReturned when the description is too long.
7636URL too longReturned when the URL is too long.
7637Image URL too longReturned when the Image URL is too long.
7638Audio play time over limitReturned when the audio play time exceeds 60 seconds.
7639Rich media messages over limitReturned when you have used up your limit to send Rich media messages.
7641Message quantity over limitReturned when you have used up your limit to send messages.
7642This user does not existReturned when the message is sent with an invalid user information.
7643Invalid image file type (invalid file type)Returned when the image file type is invalid.

Event

CodeMessageDescription
1002QueuesReturned when the request is accepted by Webex Connect.
7000Invalid JSONReturned when an invalid JSON request is sent.
7001Authentication failedReturned when an invalid service key or profile key is provided in the request.
7002Service key missingReturned when the parameter key is missing in the message request.
7004Invalid valueReturned when an invalid value for parameter is provided.
7005Internal error occurredReturned when there is an issue with Webex Connect.
7006Internal error occurredReturned when there is an issue with Webex Connect.
7025Mandatory custom parameters missingReturned when any mandatory custom event parameter is missing, where these custom parameters are created in custom event creation screen.

Profile

CodeMessageDescription
1000SuccessReturned when the request is completed successfully.
1002Partial successReturned when at least one app profile could not be created or fetched successfully.
7003CustomerId is missingReturned when the parameter CustomerId or its value is missing.
Mandatory param access_token missingReturned when the parameter access_token or its value is missing while creating an app profile.
Mandatory param access_token_expiry missingReturned when the parameter access_token_expiry is missing while creating an app profile.
Mandatory param psid missingReturned when the parameter psid is missing while creating or updating an app profile.
Mandatory param access_token_secret missingReturned when the parameter access_token_secret is missing while creating an app profile.
Mandatory param screenName missingReturned when the parameter screenName is missing while creating an app profile.
Mandatory param connectStatus missingReturned when the parameter connectStatus is missing while creating rtm profile.
Mandatory param deviceId missingReturned when the parameter deviceId is missing while creating rtm profile.
Mandatory param rtmId missingReturned when the parameter rtmId is missing while creating or updating rtm profile.
Mandatory param msisdn missingReturned when the parameter msisdn or its value is missing while creating a profile.
Mandatory param status missing or it is emptyReturned when the parameter status or its value is missing while creating or updating a profile.
Invalid value for param status, only values [0,1] are allowedReturned when the parameter status value is other than 0 or 1.
7010Source IP is not in the allowed listReturned when a request is sent from an IP that is not in the allowed list in Webex Connect.
7011Invalid Attribute ValueReturned when an invalid value is provided for the customer or app profile Attributes object.
invalid value for param status, only values [0,1] are allowedReturned when an invalid value is provided for customer or app profile Records array.
7012Batch size limit(100) exceededReturned when an API request exceeds the limit to create or update or delete using profile API.
7013Master profile store not foundReturned when a master profile store does not exists.
7014Customer not foundReturned when a customer does not exists to update or delete the profile.
App profile not foundReturned when a customers app profile does not exists to update or delete the app profile.
7015Customer already existsReturned when a customer profile is being created for which the profile already exists.
App profile already existsReturned when a customers application profile is being created for which the profile already exists.
7016Unknown errorReturned when an unknown error occurs.
7017Profile attribute doesn't existReturned when an attribute is sent for which the attribute is not defined in client master profile.
7018Invalid app profile or app profile is not linked to this clientReturned when an application master profile does not exists.
7019Request expiredReturned when the request is expired.
7020You have reached maximum transaction limitReturned when you have reached the transaction limit.
  • Please note that WeChat channel is no longer supported on Webex Connect.