API Response Codes
API response codes for Messaging, Profile and Events API
Messaging API
The API will respond with a return code to report the status of the request.
1001
| Message | Description |
|---|---|
| Queued | Returned when the request is accepted by IMIconnect. |
7000
| Message | Description |
|---|---|
| Invalid JSON | Returned when an invalid JSON request is sent. |
7001
| Message | Description |
|---|---|
| Authentication failed | Returned when an invalid service key or profile key is provided in the request. |
7002
| Message | Description |
|---|---|
| Service Key Missing | Returned when the parameter key is missing in the message request. |
7003
| Message | API | Description |
|---|---|---|
| any one of [customerid,msisdn,email, userid,pushid,fbid, twitterid, wechatid] is mandatory | Messaging | Returned when a mandatory parameter is missing for destination. |
| param 'text' is missing for android | Messaging | Returned when parameter text or its value is missing for Android in apnp object. |
| param 'text' is missing for ios | Messaging | Returned when the parameter text or its value is missing for iOS in apnp object. |
| param 'apnp' missing for push channel | Messaging | Returned when the parameter apnp is missing. |
| either android or ios information is mandatory for push channel | Messaging | Returned when the push channel is missing in apnp object. |
| param 'text' missing for channel fb | Messaging | Returned when the parameter text or its value is missing for Facebook channel. |
| param 'OTT-Messaging' missing for channel fb | Messaging | Returned when the OTT-Messaging object is missing when deliverychannel is Facebook. |
| param 'fb' missing for channel fb | Messaging | Returned when the fb object is missing in OTT-Messaging object. |
| param 'text' missing for channel wechat | Messaging | Returned when the parameter text or its value is missing for WeChat channel. |
| param 'wechat' missing for channel wechat | Messaging | Returned when the wechat object is missing in OTT-Messaging object. |
| param 'OTT-Messaging' missing for channel wechat | Messaging | Returned when the OTT-Messaging object is missing when deliverychannel is WeChat. |
| param 'text' missing for channel whatsapp | Messaging | Returned when the parameter text or its value is missing for WhatsApp channel. |
| param 'whatsapp' missing for channel whatsapp | Messaging | Returned when the wa object is missing in OTT-Messaging object. |
| param 'OTT-Messaging' missing for channel whatsapp | Messaging | Returned when the OTT-Messaging object is missing when deliverychannel is WhatsApp. |
| param 'text' missing for channel twitter | Messaging | Returned when the parameter text or its value is missing for Twitter channel. |
| param 'twitter' missing for channel twitter | Messaging | Returned when the twitter object is missing in OTT-Messaging object. |
| param 'OTT-Messaging' missing for channel twitter | Messaging | Returned when the OTT-Messaging object is missing when deliverychannel is Twitter. |
| param 'text' missing for channel rt | Messaging | Returned when the parameter text or its value is missing for rt channel. |
| param 'rt' missing for channel rt | Messaging | Returned when the rt object is missing when deliverychannel is rt. |
| 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). |
| param 'text' missing for channel sms | Messaging | Returned when the parameter text or its value is missing for sms channel. |
| param 'sms' missing for channel sms | Messaging | Returned when the sms object is missing when deliverychannel is sms. |
| either param 'callflowid' or param 'media' is required | Messaging | Returned when the parameters callflowid or media or their values are missing for voice channel. |
| param 'voice' missing for channel voice | Messaging | Returned when the voice object is missing when deliverychannel is voice. |
| No destination channel information found in request | Messaging | Returned when the value is missing for deliverychannel. |
| param 'deliverychannel' missing | Messaging | Returned when the deliverychannel is missing. |
| mandatory param device_types missing | Messaging | Returned when device_types object is missing in interactive object. |
| mandatory param value missing for action xxx | Messaging | Returned when the parameter value is missing in actions array. |
| mandatory param pos missing | Messaging | Returned when the parameter pos is missing in actions array. |
| mandatory param category missing | Messaging | Returned when the parameter category is missing in interactive object. |
| mandatory param actions missing | Messaging | Returned when the parameter actions is missing in interactive object. |
7004
| Message | Description |
|---|---|
| invalid 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 allowed | Returned when the parameter type value is other than 1 to 4 for sms channel. |
| invalid delivery channel | Returned when the parameter deliverychannel value is other than sms, voice, apnp, rt, fb, twitter, wa, wechat, or ir. |
| invalid device type xxx, only ios or android is allowed | Returned when the parameter device_types value is other than ios or android. |
| duplicate device type xxx | Returned when duplicate position value is provided in device_types array in interactive object. |
| invalid value of param pos, duplicate values for pos are not allowed | Returned when duplicate position value is provided in actions array in interactive object. |
| invalid value of param action or action is invalid for this channel | Returned when an invalid action is provided in actions array in interactive object. |
| invalid value of param value, specified value is invalid for action xxx | Returned when an invalid value is provided in value parameter in interactive actions object. |
| invalid action for identifier xxx | Returned when an invalid action is provided for corresponding category. |
| invalid identifier or no actions mapped for this identifier | Returned 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 position | Returned when identifiers are not found for a category. |
| invalid value of param pos, only positions [xx,xx] are allowed for this category | Returned when an invalid position value is provided that is not there for corresponding category. |
| invalid number of actions, expected actions size xx, but found xx | Returned when an unexpected number of actions found in interactive object. |
| invalid value of param category or no identifiers mapped to this category | Returned when an invalid category is provided in request. |
7005
| Message | Description |
|---|---|
| Request expired | Returned when the request is expired. |
7006
| Message | Description |
|---|---|
| Internal error occurred | Returned when an internal error occurs. |
7007
| Message | Description |
|---|---|
| Service Inactive | Returned when a service is in inactive state. |
7009
| Message | Description |
|---|---|
| Maximum number of destination address | Returned when an API request exceeds the limit (1000) to send messages using messaging API. |
7101
| Message | Description |
|---|---|
| Invalid Sender ID | Returned when the Sender ID is invalid. |
7102
| Message | Description |
|---|---|
| Invalid address | Returned when the address is invalid |
7104
| Message | Description |
|---|---|
| Invalid app id | Returned when the app id is invalid. |
7105
| Message | Description |
|---|---|
| Customer profile not found | Returned when the customer profile not fount. |
7106
| Message | Description |
|---|---|
| Channel not configured | Returned when the channel is not configured. |
7107
| Message | Description |
|---|---|
| Message length exceeded | Returned when the message exceeds. |
7108
| Message | Description |
|---|---|
| Invalid template | Returned when the template is invalid |
7109
| Message | Description |
|---|---|
| User in DnD | Returned when the user is registered on Do Not Disturb list. |
7110
| Message | Description |
|---|---|
| User is not active | Returned when the user is inactive. |
7111
| Message | Description |
|---|---|
| Spam content detected | Returned when the spam content is detected |
7112
| Message | Description |
|---|---|
| Invalid message type | Returned when the message type is invalid |
7113
| Message | Description |
|---|---|
| Social hours | Returned when the message is sent during non-social hours. |
7208
| Message | Description |
|---|---|
| Source IP is not whitelisted | Returned when a request is sent from an IP that is not whitelisted in IMIconnect. |
Profile API
1000
| Message | Description |
|---|---|
| Success | Returned when the request is completed successfully. |
7003
| Message | API | Description |
|---|---|---|
| customerId is missing | Profile | Returned when the parameter customerId or its value is missing. |
| mandatory param access_token missing | Profile | Returned when the parameter access_token or its value is missing while creating an app profile. |
| mandatory param access_token_expiry missing | Profile | Returned when the parameter access_token_expiry is missing while creating an app profile. |
| mandatory param fb_user_id missing | Profile | Returned when the parameter fb_user_id is missing while creating or updating an app profile. |
| mandatory param access_token_secret missing | Profile | Returned when the parameter access_token_secret is missing while creating an app profile. |
| mandatory param screenName missing | Profile | Returned when the parameter screenName is missing while creating an app profile. |
| mandatory param twitter_user_id missing | Profile | Returned when the parameter twitter_user_id is missing while creating or updating an app profile. |
| mandatory param connectStatus missing | Profile | Returned when the parameter connectStatus is missing while creating rtm profile. |
| mandatory param deviceId missing | Profile | Returned when the parameter deviceId is missing while creating rtm profile. |
| mandatory param rtmId missing | Profile | Returned when the parameter rtmId is missing while creating or updating rtm profile. |
| mandatory param wechat_user_id missing | Profile | Returned when the parameter wechat_user_id is missing while creating or updating an app profile. |
| mandatory param msisdn missing | Profile | Returned when the parameter msisdn or its value is missing while creating a profile. |
| 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. |
| invalid value for param status, only values [0,1] are allowed | Profile | Returned when the parameter status value is other than 0 or 1. |
7201
| Message | Description |
|---|---|
| Invalid profile | Returned when profile id is invalid during get, update or delete profile |
7202
| Message | Description |
|---|---|
| Invalid attribute | Returned when an invalid attribute is passed in the body of add or update profile |
7203
| Message | Description |
|---|---|
| Customer/App not found | Returned when a customer or application does not exists to update or delete the profile. |
| app profile not found | Returned when a customers app profile does not exists to update or delete the app profile. |
7205
| Message | Description |
|---|---|
| Invalid attribute value | Returned when an invalid value is provided for the customer or app profile Attributes object. |
| invalid value for param status, only values [0,1] are allowed | Returned when an invalid value is provided for customer or app profile Records array. |
7206
| Message | Description |
|---|---|
| Master profile store not found | Returned when a master profile store does not exists. |
7207
| Message | Description |
|---|---|
| Batch size limit (100) exceeded | Returned when an API request exceeds the limit to create or update or delete using profile API. |
7208
| Message | Description |
|---|---|
| Source IP is not whitelisted | Returned when a request is sent from an IP that is not whitelisted in IMIconnect. |
7209
| Message | Description |
|---|---|
| Customer/App profile already exists | Returned when a customer or application profile is being created for which the profile already exists. |
| app profile already exists | Returned when a customers application profile is being created for which the profile already exists. |
7210
| Message | Description |
|---|---|
| Unknown error | Returned when an unknown error occurs. |
7211
| Message | Description |
|---|---|
| Profile attribute does not exist | Returned when an attribute is sent for which the attribute is not defined in client master profile. |
7212
| Message | Description |
|---|---|
| Invalid app profile or app profile not linked to this client. | Returned when an application master profile does not exists. |
Event API
1002
| Message | Description |
|---|---|
| Queued | Returned when the request is accepted by IMIconnect. |
7000
| Message | Description |
|---|---|
| Invalid JSON | Returned when an invalid JSON request is sent. |
7001
| Message | Description |
|---|---|
| Authentication failed | Returned when an invalid service key or profile key is provided in the request. |
7002
| Message | Description |
|---|---|
| Service Key Missing | Returned when the parameter key is missing in the message request. |
7003
| Message | Description |
|---|---|
| Mandatory parameters missing. | Returned when the mandatory parameters configured in custom event are missing. |
7005
| Message | Description |
|---|---|
| Internal error occurred. | Returned when there is an issue with IMIconnect. |
Updated about 1 year ago