API Status Codes
API status codes for Messaging, Profile, Transaction Status, and Events API.
The APIs will respond with a code to report the status of the request.
| Code | Message | API | Description |
|---|---|---|---|
| 1000 | Success | Profile | Returned when the request is completed successfully. |
| 1002 | Queued | Event | Returned when the request is accepted by IMIconnect. |
| 1002 | Partial success | Profile | Returned when at least one app profile could not be created or fetched successfully. |
| 7000 | Invalid JSON | Messaging, Event | Returned when an invalid JSON request is sent. |
| 7001 | Authentication failed | Messaging, Event | Returned when an invalid service key or profile key is provided in the request. |
| 7002 | Service Key Missing | Messaging, Event | Returned when the parameter key is missing in the message request. |
| 7003 | any one of [customerid,msisdn,email, userid,pushid,psid, twitterid, wechatid] is mandatory | Messaging | Returned when a mandatory parameter is missing for destination. |
| 7003 | Mandatory parameters missing | Event | Returned when the mandatory parameters configured in custom event are missing. |
| 7003 | param 'text' is missing for android | Messaging | Returned when parameter text or its value is missing for Android in push object. |
| 7003 | param 'text' is missing for ios | Messaging | Returned when the parameter text or its value is missing for iOS in push object. |
| 7003 | param 'push' missing for push channel | Messaging | Returned when the parameter push is missing. |
| 7003 | either android or ios information is mandatory for push channel | Messaging | Returned when the push channel is missing in push object. |
| 7003 | param 'text' missing for channel fb | Messaging | Returned when the parameter text or its value is missing for Facebook channel. |
| 7003 | param 'OTT-Messaging' missing for channel fb | Messaging | Returned when the OTT-Messaging object is missing when deliverychannel is Facebook. |
| 7003 | param 'fb' missing for channel fb | Messaging | Returned when the fb object is missing in OTT-Messaging object. |
| 7003 | param 'text' missing for channel wechat | Messaging | Returned when the parameter text or its value is missing for WeChat channel. |
| 7003 | param 'wechat' missing for channel wechat | Messaging | Returned when the wechat object is missing in OTT-Messaging object. |
| 7003 | param 'OTT-Messaging' missing for channel wechat | Messaging | Returned when the OTT-Messaging object is missing when deliverychannel is WeChat. |
| 7003 | param 'text' missing for channel whatsapp | Messaging | Returned when the parameter text or its value is missing for WhatsApp channel. |
| 7003 | param 'whatsapp' missing for channel whatsapp | Messaging | Returned when the wa object is missing in OTT-Messaging object. |
| 7003 | param 'OTT-Messaging' missing for channel whatsapp | Messaging | Returned when the OTT-Messaging object is missing when deliverychannel is WhatsApp. |
| 7003 | param 'text' missing for channel twitter | Messaging | Returned when the parameter text or its value is missing for Twitter channel. |
| 7003 | param 'twitter' missing for channel twitter | Messaging | Returned when the parameter text or its value is missing for Twitter channel. |
| 7003 | param 'twitter' missing for channel twitter | Messaging | Returned when the twitter object is missing in OTT-Messaging object. |
| 7003 | param 'OTT-Messaging' missing for channel twitter | Messaging | Returned when the OTT-Messaging object is missing when deliverychannel is Twitter. |
| 7003 | param 'text' missing for channel rt | Messaging | Returned when the parameter text or its value is missing for rt channel. |
| 7003 | param 'appmessaging' missing for channel rt | Messaging | Returned when the rt object is missing when deliverychannel is rt. |
| 7003 | param 'body' missing for channel sms | Messaging | Returned when the parameter body or its value is missing for sms channel and the parameter type is not selected as text (1). |
| 7003 | param 'text' missing for channel sms | Messaging | Returned when the parameter text or its value is missing for sms channel. |
| 7003 | param 'sms' missing for channel sms | Messaging | Returned when the sms object is missing when deliverychannel is sms. |
| 7003 | either param 'callflowid' or param 'media' is required | Messaging | Returned when the parameters callflowid or media or their values are missing for voice channel. |
| 7003 | param 'voice' missing for channel voice | Messaging | Returned when the voice object is missing when deliverychannel is voice. |
| 7003 | No destination channel information found in request | Messaging | Returned when the value is missing for deliverychannel. |
| 7003 | param 'deliverychannel' missing | Messaging | Returned when the deliverychannel is missing. |
| 7003 | mandatory param device_types missing | Messaging | Returned when device_types object is missing in interactive object. |
| 7003 | mandatory param value missing for action xxx | Messaging | Returned when the parameter value is missing in actions array. |
| 7003 | mandatory param pos missing | Messaging | Returned when the parameter pos is missing in actions array. |
| 7003 | mandatory param category missing | Messaging | Returned when the parameter category is missing in interactive object. |
| 7003 | mandatory param actions missing | Messaging | Returned when the parameter actions is missing in interactive object. |
| 7003 | customerId is missing | Profile | Returned when the parameter customerId or its value is missing. |
| 7003 | mandatory param access_token missing | Profile | Returned when the parameter access_token or its value is missing while creating an app profile. |
| 7003 | mandatory param access_token_expiry missing | Profile | Returned when the parameter access_token_expiry is missing while creating an app profile. |
| 7003 | mandatory param psid missing | Profile | Returned when the parameter psid is missing while creating or updating an app profile. |
| 7003 | mandatory param access_token_secret missing | Profile | Returned when the parameter access_token_secret is missing while creating an app profile. |
| 7003 | mandatory param screenName missing | Profile | Returned when the parameter screenName is missing while creating an app profile. |
| 7003 | mandatory param twitter_user_id missing | Profile | Returned when the parameter twitter_user_id is missing while creating or updating an app profile. |
| 7003 | mandatory param connectStatus missing | Profile | Returned when the parameter connectStatus is missing while creating rtm profile. |
| 7003 | mandatory param deviceId missing | Profile | Returned when the parameter deviceId is missing while creating rtm profile. |
| 7003 | mandatory param rtmId missing | Profile | Returned when the parameter rtmId is missing while creating or updating rtm profile. |
| 7003 | mandatory param wechat_user_id missing | Profile | Returned when the parameter wechat_user_id is missing while creating or updating an app profile. |
| 7003 | mandatory param msisdn missing | Profile | Returned when the parameter msisdn or its value is missing while creating a profile. |
| 7003 | mandatory param status missing or it is empty | Profile | Returned when the parameter status or its value is missing while creating or updating a profile. |
| 7003 | invalid value for param status, only values [0,1] are allowed | Profile | Returned when the parameter status value is other than 0 or 1. |
| 7004 | invalid value for param 'priority', it should be one of [1,2,3,4,5] | Messaging | Returned when the parameter priority value is other than 1 to 5 for rt channel. |
| 7004 | invalid value of param 'type' , only [1,2,3,4] are allowed | Messaging | Returned when the parameter type value is other than 1 to 4 for sms channel. |
| 7004 | invalid delivery channel | Messaging | Returned when the parameter deliverychannel value is other than sms, voice, push, rt, fb, twitter, wa, wechat, or ir. |
| 7004 | invalid device type xxx, only ios or android is allowed | Messaging | Returned when the parameter device_types value is other than ios or android. |
| 7004 | duplicate device type xxx | Messaging | Returned when duplicate position value is provided in device_types array in interactive object. |
| 7004 | invalid value of param pos, duplicate values for pos are not allowed | Messaging | Returned when duplicate position value is provided in actions array in interactive object. |
| 7004 | invalid value of param action or action is invalid for this channel | Messaging | Returned when an invalid action is provided in actions array in interactive object. |
| 7004 | invalid value of param value, specified value is invalid for action xxx | Messaging | Returned when an invalid value is provided in value parameter in interactive actions object. |
| 7004 | invalid action for identifier xxx | Messaging | Returned when an invalid action is provided for corresponding category. |
| 7004 | invalid identifier or no actions mapped for this identifier | Messaging | Returned when the corresponding identifiers for category are not mapped to the identifiers that are there for actions. |
| 7004 | no identifier found for this category and at this position | Messaging | Returned when identifiers are not found for a category. |
| 7004 | Invalid value of param pos, only positions [xx,xx] are allowed for this category | Messaging | Returned when an invalid position value is provided that is not there for corresponding category. |
| 7004 | Invalid number of actions, expected actions size xx, but found xx | Messaging | Returned when an unexpected number of actions found in interactive object. |
| 7004 | Invalid value of param category or no identifiers mapped to this category | Messaging | Returned when an invalid category is provided in request. |
| 7004 | Invalid value for param evtid | Event | Returned when an invalid value for parameter evtid is provided request. |
| 7005 | Request expired | Messaging | Returned when the request is expired. |
| 7005 | Internal error occurred | Event | Returned when there is an issue with IMIconnect. |
| 7006 | Internal error occurred | Messaging | Returned when an internal error occurs. |
| 7006 | Internal error occurred | Event | Returned when there is an issue with IMIconnect. |
| 7006 | Internal server error | Transaction Status, Messaging | Returned when an occur occurs in server. |
| 7007 | Service Inactive | Messaging | Returned when a service is in inactive state. |
| 7008 | Inactive Profile | Transaction Status, Messaging | Returned when the profile is inactive. |
| 7009 | Maximum number of destination address | Messaging | Returned when an API request exceeds the limit (1000) to send messages using messaging API. |
| 7010 | Source IP is not whitelisted | Profile | Returned when a request is sent from an IP that is not whitelisted in IMIconnect. |
| 7010 | Service provider exceptioni | Transaction Status, Messaging | Returned when a service provider exception occurs. |
| 7011 | Invalid Attribute Value | Profile | Returned when an invalid value is provided for the customer or app profile Attributes object. |
| 7011 | invalid value for param status, only values [0,1] are allowed | Profile | Returned when an invalid value is provided for customer or app profile Records array. |
| 7011 | Unknown Exception | Transaction Status, Messaging | Returned when an unknown exception occurs. |
| 7012 | Batch size limit(100) exceeded | Profile | Returned when an API request exceeds the limit to create or update or delete using profile API. |
| 7013 | Master profile store not found | Profile | Returned when a master profile store does not exists. |
| 7014 | Customer not found | Profile | Returned when a customer does not exists to update or delete the profile. |
| 7014 | app profile not found | Profile | Returned when a customers app profile does not exists to update or delete the app profile. |
| 7015 | Customer already exists | Profile | Returned when a customer profile is being created for which the profile already exists. |
| 7015 | app profile already exists | Profile | Returned when a customers application profile is being created for which the profile already exists. |
| 7016 | Unknwon error | Profile | Returned when an unknown error occurs. |
| 7017 | Profile attribute doesn't exist | Profile | Returned when an attribute is sent for which the attribute is not defined in client master profile. |
| 7018 | invalid app profile or app profile is not linked to this client | Profile | Returned when an application master profile does not exists. |
| 7019 | Request expired | Profile, Messaging, Transaction Status | Returned when the request is expired. |
| 7020 | You have reached maximum transaction limit | Profile, Messaging, Transaction Status | Returned when you have reached the transaction limit. |
| 7025 | Mandatory custom parameters missing | Event | Returns when any mandatory custom event parameter is missing, where these custom parameters are created in custom event creation screen. |
| 7101 | Invalid Sender ID | Transaction Status, Messaging | Returned when the sender ID is invalid. |
| 7102 | Invalid address | Transaction Status, Messaging | Returned when the address is invalid. |
| 7103 | Not enough credits | Transaction Status, Messaging | Returned when the client does not have enough credits in his account. |
| 7104 | Invalid app id | Transaction Status, Messaging | Returned when the app id is invalid. |
| 7105 | Customer profile not found | Transaction Status, Messaging | Returned when the customer profile is not found. |
| 7106 | Channel not configured | Transaction Status, Messaging | Returned when the channel is not configured. |
| 7107 | Message length exceeded | Transaction Status, Messaging | Returned when the length of the message exceeded. |
| 7108 | Invalid template | Transaction Status, Messaging | Returned when the template is invalid. |
| 7109 | User in DnD | Transaction Status, Messaging | Returned when the user is registered on Do Not Disturb list. |
| 7110 | User is not active | Transaction Status, Messaging | Returned when the user is in inactive state. |
| 7111 | Spam content detected | Transaction Status, Messaging | Returned when the content contains a spam word. |
| 7112 | Invalid message type | Transaction Status, Messaging | Returned when the message type is invalid. |
| 7113 | Social hours | Transaction Status, Messaging | Returned when the message is sent during non-social hours. |
| 7114 | Configuration Error. Please contact admin. | Transaction Status, Messaging | Returned when there is an error in configuration. |
| 7115 | Rate plan not defined | Transaction Status, Messaging | Returned when the rate plan is not defined. |
| 7116 | Destination profile is not verified | Transaction Status, Messaging | Returned when the destination profile is not verified. |
| 7117 | RTM is not enabled for this app | Transaction Status, Messaging | Returned when RTM is not enabled for this application. |
| 7118 | push is not enabled for this app | Transaction Status, Messaging | Returned when push is not enabled for this application. |
| 7119 | Destination profile doesn't have OS details | Transaction Status, Messaging | Returned when the destination profile does not have OS details. |
| 7120 | Voice params length exceeded | Transaction Status, Messaging | Returned when the voice parameters length is exceeded. |
| 7121 | Replaceable params could not be fetched. | Transaction Status, Messaging | Returned when the replaceable parameters could not be fetched. |
| 7200 | Unknown Status | Transaction Status, Messaging | Returned when the status is unknown. |
| 7201 | Delivery failed at Operator | Transaction Status, Messaging | Returned when the delivery failed at operator. |
| 7201 | Invalid Profile | Profile API | Returned when profile id is invalid during get, update or delete profile |
| 7202 | Delivery failed at platform | Transaction Status, Messaging | Returned when the delivery failed at platform. |
| 7202 | Invalid attribute | Profile API | Returned when an invalid attribute is passed in the body of add or update profile |
| 7203 | Unknown Subscriber address | Transaction Status, Messaging | Returned when the subscriber address is not known. |
| 7204 | Insufficient Credits in subscriber account | Transaction Status, Messaging | Returned when the subscriber account has insufficient credits. |
| 7205 | Error in Binary message | Transaction Status, Messaging | Returned when there is an error in binary message. |
| 7206 | Can't deliver. Subscriber SIM Full | Transaction Status, Messaging | Returned when the subscribers sim is full. |
| 7207 | Subscriber out of coverage area or not reachable | Transaction Status, Messaging | Returned when the subscriber is out of coverage area. |
| 7208 | Source ip is not white listed | Messaging | Returned when the source IP is not whitelisted. |
| 7208 | Message expired | Transaction Status, Messaging | Returned when message is expired. |
| 7209 | Unable to deliver multipart message | Transaction Status, Messaging | Returned when unable to deliver multipart message. |
| 7210 | Billing Configuration error | Transaction Status, Messaging | Returned when there is an error in billing configuration. |
| 7211 | Billing error at operator | Transaction Status, Messaging | Returned when an error occurs at operator. |
| 7212 | Invalid registration | Transaction Status, Messaging | Returned when the registration is invalid. |
| 7213 | Unregistered | Transaction Status, Messaging | Returned when the user is not registered. |
| 7214 | Cloud specific failure | Transaction Status, Messaging | Returned due to cloud failure. |
| 7301 | Message expired | Transaction Status, Messaging | Returned when the message is expired. |
| 7302 | Rate limit exceeded | Transaction Status, Messaging | Returned when the rate limit exceeded. |
| 7303 | Delivery notification of a message expired | Transaction Status, Messaging | Returned when the delivery notification of a message is expired. |
| 7304 | Invalid app credentials(Invalid OAuth) | Transaction Status, Messaging | Returned when invalid app credentials are provided. |
| 7305 | Invalid user credentials | Transaction Status, Messaging | Returned when user credentials are invalid. |
| 7306 | Duplicate message for twitter | Transaction Status, Messaging | Returned when a duplicate message is sent on twitter. |
| 7307 | End point not reachable(FB is not reachable) | Transaction Status, Messaging | Returned when Facebook is not reachable |
| 7401 | No answer | Transaction Status, Messaging | Returned when the call is not answered. |
| 7402 | Customer busy | Transaction Status, Messaging | Returned when the customer is busy. |
| 7403 | Call rejected | Transaction Status, Messaging | Returned when the call is rejected. |
| 7404 | Others | Transaction Status, Messaging | Returned for other errors |
| 7500 | Delivered | Transaction Status, Messaging | Returned when the delivery is completed successfully. |
| 7501 | Submited | Transaction Status, Messaging | Returned when the submit is success. |
| 7502 | Read | Transaction Status, Messaging | Returned when the message is read. |
| 7503 | Message expired before delivery attempt | Transaction Status, Messaging | Returned when the message is expired before attempting a delivery. |
| 7504 | Authentication error | Transaction Status, Messaging | Returned when an authentication error occurs. |
| 7505 | Too large payload ( >4kb) | Transaction Status, Messaging | Returned when the payload is more than 4kb for Android. |
| 7506 | Invalid time to live value | Transaction Status, Messaging | Returned when an invalid value is passed for time to live parameter for Android |
| 7507 | Too many requests for the App | Transaction Status, Messaging | Returned when too many requests are received for the same app. |
| 7508 | GCM server error | Transaction Status, Messaging | Returned when an error occurs in Google Cloud Messaging server |
| 7509 | Too many concurrent requests for same customer | Transaction Status, Messaging | Returned when too many requests are received for the same customer. |
| 7510 | Too big payload | Transaction Status, Messaging | Returned when the payload is more than 4kb for iOS. |
| 7511 | Invalid time to live value | Transaction Status, Messaging | Returned when an invalid value is passed for time to live parameter for iOS. |
| 7512 | Invalid push id | Transaction Status, Messaging | Returned when the push id is invalid. |
| 7513 | Unregistered Device | Transaction Status, Messaging | Returned when a device is not registered. |
| 7514 | Wrong apns certificate gateway | Transaction Status, Messaging | Returned when a wrong apns certificate is provided. |
| 7515 | Bad apns certificate | Transaction Status, Messaging | Returned when an apns certificate is invalid. |
| 7516 | Too many request for the same device | Transaction Status, Messaging | Returned when too many requests are received by the same device. |
| 7517 | APNS server error | Transaction Status, Messaging | Returned when an apns server error occurs. |
| 7518 | Unknown | Transaction Status, Messaging | Returned when an unknown error occurs. |
| 7600 | no results found | Transaction Status, Messaging | Returned when the results are not found. |
| 7601 | transaction is not under this service or service key is invalid | Transaction Status, Messaging | Returned when there is a mismatch with the service key or transaction. |
| 7601 | Verification failed | Transaction Status, Messaging | Returns then the verification is failed |
| 7602 | user presence failure | Transaction Status, Messaging | Returned when the user not available in the network. |
| 7602 | Invalid WeChat User ID | Transaction Status, Messaging | Returned when the WeChat user id is invalid. |
| 7603 | either validation failed for request or user verification failure | Transaction Status, Messaging | Returned when the validation is failed or user verification is failed for the request. |
| 7603 | Invalid media file type | Transaction Status, Messaging | Returned when the media file is other than WeChat supported media files. |
| 7604 | Invalid file type | Transaction Status, Messaging | Returned when the file is other than WeChat supported media files. |
| 7605 | Invalid file size | Transaction Status, Messaging | Returned when the WeChat file size exceeds the limit. |
| 7606 | Invalid media file ID | Transaction Status, Messaging | Returned when the WeChat media file id is invalid. |
| 7607 | Invalid message type | Transaction Status, Messaging | Returned when the WeChat message type is invalid. |
| 7608 | Invalid image file size | Transaction Status, Messaging | Returned when the image file size exceeds the limit. |
| 7609 | Invalid audio file size | Transaction Status, Messaging | Returned when the audio file size exceeds 256K. |
| 7610 | Invalid video file size | Transaction Status, Messaging | Returned when the audio file size exceeds 1MB. |
| 7611 | Invalid thumbnail file size | Transaction Status, Messaging | Returned when the thumbnail file size exceeds 64KB. |
| 7612 | Invalid App ID | Transaction Status, Messaging | Returned when the WeChat app id is invalid. |
| 7613 | Invalid access token | Transaction Status, Messaging | Returned when the WeChat access token is invalid. |
| 7614 | Invalid oauth code | Transaction Status, Messaging | Returned when the WeChat oauth code is invalid. |
| 7615 | Invalid refresh token | Transaction Status, Messaging | Returned when the WeChat refresh token is invalid. |
| 7616 | Invalid openid list | Transaction Status, Messaging | Returned when the WeChat openid list is invalid. |
| 7617 | Invalid openid list length | Transaction Status, Messaging | Returned when the WeChat openid list length exceeds the limit. |
| 7618 | Invalid request characters: The character uxxxx cannot be included | Transaction Status, Messaging | Returned when the message format is invalid. |
| 7619 | Invalid parameters | Transaction Status, Messaging | Returned when the WeChat API is accessed with invalid parameters. |
| 7620 | Invalid request format | Transaction Status, Messaging | Returned when the WeChat API is accessed with invalid request format. |
| 7621 | Invalid URL length | Transaction Status, Messaging | Returned when the WeChat API is accessed with a lengthy URL. |
| 7622 | Parameter missing: access token | Transaction Status, Messaging | Returned when the WeChat API is accessed without an access token. |
| 7623 | Parameter missing: appid | Transaction Status, Messaging | Returned when the WeChat API is accessed without an appid. |
| 7624 | Parameter missing: refresh token | Transaction Status, Messaging | Returned when the WeChat API is accessed without a refresh token. |
| 7625 | Parameter missing: secret | Transaction Status, Messaging | Returned when the WeChat API is accessed without a secret key. |
| 7626 | Multimedia file data missing | Transaction Status, Messaging | Returned when the WeChat API is accessed with an invalid media file. |
| 7627 | Parameter missing: media id | Transaction Status, Messaging | Returned when the message is sent without media id parameter. |
| 7628 | The other user is not yet a follower | Transaction Status, Messaging | Returned when the message is sent to a non follower. |
| 7629 | The other user is not yet a follower | Transaction Status, Messaging | Returned when the message is sent to a non follower. |
| 7630 | Rich media message is empty | Transaction Status, Messaging | Returned when the message is sent without rich media. |
| 7631 | Text message is empty | Transaction Status, Messaging | Returned when the message is sent without a text. |
| 7632 | Error source: multimedia file size | Transaction Status, Messaging | Returned when the media size is beyond the expected size. |
| 7633 | Message contents too long | Transaction Status, Messaging | Returned when the message is sent with a lengthy text. |
| 7634 | Title too long | Transaction Status, Messaging | Returned when the message title is too long. |
| 7635 | Description too long | Transaction Status, Messaging | Returned when the description is too long. |
| 7636 | URL too long | Transaction Status, Messaging | Returned when the URL is too long. |
| 7637 | Image URL too long | Transaction Status, Messaging | Returned when the Image URL is too long. |
| 7638 | Audio play time over limit | Transaction Status, Messaging | Returned when the audio play time exceeds 60 seconds. |
| 7639 | Rich media messages over limit | Transaction Status, Messaging | Returned when you have used up your limit to send Rich media messages. |
| 7640 | Error source: interface call | Transaction Status, Messaging | Returned when the WeChat API is requested incorrectly. |
| 7641 | Message quantity over limit | Transaction Status, Messaging | Returned when you have used up your limit to send messages. |
| 7642 | This user does not exist. | Transaction Status, Messaging | Returned when the message is sent with an invalid user information. |
| 7643 | Invalid image file type (invalid file type) | Transaction Status, Messaging | Returned when the image file type is invalid. |
| 7700 | Workflow session not available with the given information. | Deletesession | Returned when workflow session is not available with the given values. |
| 7701 | Workflow service not available with the given information. | Deletesession | Returned when workflow service is not available with the given values. |
Updated about 5 years ago