Transaction Status

Request

The status of a transaction made through messaging API is requested as follows:


URL	https://api.imiconnect.io/resources/v1/messaging/status/ Note: If your IMIconnect web access URL is on a .io TLD, then you should use the API end point with .io. For example, if your domain is mycompany.imiconnect.com then your API base URL will be api.imiconnect.com. But if your domain is mycompany.imiconnect.io then your API base URL will be api.imiconnect.io. where transactionid* is the transaction ID returned during the messaging request.
Method	GET

URL

https://api.imiconnect.io/resources/v1/messaging/status/ Note: If your IMIconnect web access URL is on a .io TLD, then you should use the API end point with .io. For example, if your domain is mycompany.imiconnect.com then your API base URL will be api.imiconnect.com. But if your domain is mycompany.imiconnect.io then your API base URL will be api.imiconnect.io.
*where
transactionid** is the transaction ID returned during the messaging request.

Method

GET

##Request Example

https://api.imiconnect.com/resources/v1/messaging/status/8026899a-bed4-4ea4-b1cd-eef98829dbd1

##Response Examples

[{
    "transactionid": "8026899a-bed4-4ea4-b1cd-eef98829dbd1",
    "clientid": "412",
    "api_version": "v1",
    "type": "outbound-api",
    "from": "VM-CONNECT",
    "to": "<mobile_number>",
    "body": "request JSON",
    “channel”: ”SMS”,
    "status": "sent", //(queued, delivered, failed, expired)
    "date_created": "Mon, 16 Aug 2010 03:45:01 UTC",
    "last_updated": "Mon, 16 Aug 2010 03:45:03 UTC",
    "error_code": null,
    "error_message": null,
}]

[{
    "transactionid": "8026899a-bed4-4ea4-b1cd-eef98829dbd1",
    "clientid": "412",
    "api_version": "v1",
    "type": "outbound-api",
    "from": "VM-CONNECT",
    "to": "+919642454694",
    "callflowid": "917",
    "channel": "voice",
    "status": "sent", //(queued, answered, no answer, rejected, busy, others)
    "date_created": "Mon, 16 Aug 2010 03:45:01 UTC",
    "last_updated": "Mon, 16 Aug 2010 03:45:03 UTC",
    "error_code": null,
    "error_message": null,
}]

[{
    "transactionid": "8026899a-bed4-4ea4-b1cd-eef98829dbd1",
    "clientid": "412",
    "api_version": "v1",
    "type": "outbound-api",
    "from": "VM-CONNECT",
    "to": "+919642454694",
    "body": "Hello",
    "channel": "fb / tiwtter / wechat",
    "appid": "a_1234556677",
    "status": "sent", //(queued, delivered, read, failed, expired)
    "date_created": "Mon, 16 Aug 2010 03:45:01 UTC",
    "last_updated": "Mon, 16 Aug 2010 03:45:03 UTC",
    "error_code": null,
    "error_message": null,
}]

[{
    "transactionid": "8026899a-bed4-4ea4-b1cd-eef98829dbd1",
    "clientid": "412",
    "api_version": "v1",
    "type": "outbound-api",
    "from": "<senderid>",
    "to": "<to>",
    "appid": "a_123455667",
    "channel": "RTM",
    "message": "message",
    "status": "sent", // (queued, delivered, read, failed, expired)
    "date_created": "Mon, 16 Aug 2010 03:45:01 UTC",
    "last_updated": "Mon, 16 Aug 2010 03:45:03 UTC",
    "error_code": null,
    "error_message": null,
}]

[{
    "transactionid": "8026899a-bed4-4ea4-b1cd-eef98829dbd1",
    "clientid": "412",
    "api_version": "v1",
    "type": "outbound-api",
    "from": "VM-CONNECT",
    "to": "<to>",
    "appid": "a_123455667",
    "channel": "push",
    "status": "sent", //(queued, delivered, read, failed, expired)
    "date_created": "Mon, 16 Aug 2010 03:45:01 UTC",
    "last_updated": "Mon, 16 Aug 2010 03:45:03 UTC",
    "error_code": null,
    "error_message": null,
}]

Response Body

The parameters of response body are:

Name	Description
transactionid	Specifies the transaction ID returned during the messaging request.
clientid	Specifies the client ID in IMIconnect.
api_version	Specifies the Messaging API version.
type	Specifies the type of the API.
from	Specifies the originating point of the message. SMS - Sender ID or Short code Voice - CLI number or Sender ID. RTM - Sender id
to	Specifies the destination point of the message. For example, SMS and Voice - MSISDN Facebook - Facebook user ID RTM and Push - Customer ID
body	Specifies the message sent.
channel	Specifies the channel through which the message was sent.
appid	Specifies the appid that is generated while creating an app.
status	Specifies the status of the message. The options are: sent queued delivered read failed expired answered rejected busy others no answer
date_created	Specifies the date when the message was initiated.
last_updated	Specifies the last updated date of the transaction.
error_code	Specifies the error code when status of the message is not success.
error_message	Specifies the description of the error.

Status Codes

This API may return the following response codes:

Return Code	Message	Description
7000	Invalid JSON	Returned when an invalid JSON request is sent.
7001	Authentication failed	Returned when an invalid service key or profile key is provided in the request.
7002	Service Key Missing	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	Returned when a mandatory parameter is missing for destination.
7003	Mandatory parameters missing.	Returned when the mandatory parameters configured in custom event are missing.
7003	param 'text' is missing for android	Returned when parameter text or its value is missing for Android in push object.
7003	param 'text' is missing for ios	Returned when the parameter text or its value is missing for iOS in push object.
7003	param 'push' missing for push channel	Returned when the parameter push is missing.
7003	either android or ios information is mandatory for push channel	Returned when the push channel is missing in push object.
7003	param 'text' missing for channel fb	Returned when the parameter text or its value is missing for Facebook channel.
7003	param 'OTT-Messaging' missing for channel fb	Returned when the OTT-Messaging object is missing when deliverychannel is Facebook.
7003	param 'fb' missing for channel fb	Returned when the fb object is missing in OTT-Messaging object.
7003	param 'text' missing for channel wechat	Returned when the parameter text or its value is missing for WeChat channel.
7003	param 'wechat' missing for channel wechat	Returned when the wechat object is missing in OTT-Messaging object.
7003	param 'OTT-Messaging' missing for channel wechat	Returned when the OTT-Messaging object is missing when deliverychannel is WeChat.
7003	param 'text' missing for channel twitter	Returned when the parameter text or its value is missing for Twitter channel
7003	param 'twitter' missing for channel twitter	Returned when the parameter text or its value is missing for Twitter channel.
7003	param 'twitter' missing for channel twitter	Returned when the twitter object is missing in OTT-Messaging object.
7003	param 'OTT-Messaging' missing for channel twitter	Returned when the OTT-Messaging object is missing when deliverychannel is Twitter.
7003	param 'text' missing for channel rt	Returned when the parameter text or its value is missing for rt channel.
7003	param 'rt' missing for channel rt	Returned when the rt object is missing when deliverychannel is rt.
7003	param 'body' missing for channel sms	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	Returned when the parameter text or its value is missing for sms channel.
7003	param 'sms' missing for channel sms	Returned when the sms object is missing when deliverychannel is sms.
7003	either param 'callflowid' or param 'media' is required	Returned when the parameters callflowid or media or their values are missing for voice channel.
7003	param 'voice' missing for channel voice	Returned when the voice object is missing when deliverychannel is voice.
7003	No destination channel information found in request	Returned when the value is missing for deliverychannel.
7003	param 'deliverychannel' missing	Returned when the deliverychannel is missing.
7003	mandatory param device_types missing	Returned when devicetypes object is missing in _interactive object.
7003	mandatory param value missing for action xxx	Returned when the parameter value is missing in actions array.
7003	mandatory param pos missing	Returned when the parameter pos is missing in actions array.
7003	mandatory param category missing	Returned when the parameter category is missing in interactive object.
7003	mandatory param actions missing	Returned when the parameter actions is missing in interactive object.
7004	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.
7004	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.
7004	invalid delivery channel	Returned when the parameter delivery channel value is other than sms, voice, push, rt, fb, twitter or wechat.
7004	invalid device type xxx, only ios or android is allowed	Returned when the parameter device_types value is other than ios or android.
7004	duplicate device type xxx	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	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	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	Returned when an invalid value is provided in value parameter in interactive actions object.
7004	invalid action for identifier xxx	Returned when an invalid action is provided for corresponding category.
7004	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.
7004	no identifier found for this category and at this position	Returned when identifiers are not found for a category.
7004	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.
7004	invalid number of actions, expected actions size xx, but found xx	Returned when an unexpected number of actions found in interactive object.
7004	invalid value of param category or no identifiers mapped to this category	Returned when an invalid category is provided in request.
7005	Request expired	Returned when the request is expired.
7006	Internal error occurred	Returned when an internal error occurs.
7007	Service Inactive	Returned when a service is in inactive state.
7009	Maximum number of destination address	Returned when an API request exceeds the limit (1000) to send messages using messaging API.
7101	Invalid Sender ID	Returned when the sender ID is invalid.
7102	Invalid address	Returned when the address is invalid.
7103	Not enough credits	Returned when the client does not have enough credits in his account.
7104	Invalid app id	Returned when the app id is invalid.
7105	Customer profile not found	Returned when the customer profile is not found.
7106	Channel not configured	Returned when the channel is not configured.
7107	Message length exceeded	Returned when the length of the message exceeded.
7108	Invalid template	Returned when the template is invalid.
7109	User in DnD	Returned when the user is registered on Do Not Disturb list.
7110	User is not active	Returned when the user is in inactive state.
7111	Spam content detected	Returned when the content contains a spam word.
7112	Invalid message type	Returned when the message type is invalid.
7113	Social hours	Returned when the message is sent during non-social hours.
7114	Configuration Error. Please contact admin.	Returned when there is an error in configuration.
7115	Rate plan not defined	Returned when the rate plan is not defined.
7116	Destination profile is not verified	Returned when the destination profile is not verified.
7117	RTM is not enabled for this app	Returned when RTM is not enabled for this application.
7118	Push is not enabled for this app	Returned when Push is not enabled for this application.
7119	Destination profile doesn't have OS details	Returned when the destination profile does not have OS details.
7120	Voice params length exceeded	Returned when the voice parameters length is exceeded.
7121	Replaceable params could not be fetched.	Returned when the replaceable parameters could not be fetched.
7200	Unknown Status	Returned when the status is unknown.
7201	Delivery failed at Operator	Returned when the delivery failed at operator.
7202	Delivery failed at platform	Returned when the delivery failed at platform.
7203	Unknown Subscriber address	Returned when the subscriber address is not known.
7204	Insufficient Credits in subscriber account	Returned when the subscriber account has insufficient credits.
7205	Error in Binary message	Returned when there is an error in binary message.
7206	Can't deliver. Subscriber SIM Full	Returned when the subscribers sim is full.
7207	Subscriber out of coverage area or not reachable	Returned when the subscriber is out of coverage area.
7208	Source ip is not white listed	Returned when the source IP is not whitelisted.
7209	Unable to deliver multipart message	Returned when unable to deliver multi part message.
7210	Billing Configuration error	Returned when there is an error in billing configuration.
7211	Billing error at operator	Returned when an error occurs at operator.
7212	Invalid registration	Returned when the registration is invalid.
7213	Unregistered	Returned when the user is not registered.
7214	Cloud specific failure	Returned due to cloud failure.
7301	Message expired	Returned when the message is expired.
7302	Rate limit exceeded	Returned when the rate limit exceeded.
7303	Delivery notification of a message expired	Returned when the delivery notification of a message is expired.
7304	Invalid app credentials(Invalid OAuth)	Returned when invalid app credentials are provided.
7305	Invalid user credentials	Returned when user credentials are invalid.
7306	Duplicate message for twitter	Returned when a duplicate message is sent on Twitter.
7307	End point not reachable(FB is not reachable)	Returned when Facebook is not reachable
7401	No answer	Returned when the call is not answered.
7402	Customer busy	Returned when the customer is busy.
7403	Call rejected	Returned when the call is rejected.
7404	Others	Returned for other errors
7500	Delivered	Returned when the delivery is completed successfully.
7501	Submited	Returned when the submit is success.
7502	Read	Returned when the message is read.
7600	no results found	Returned when the results are not found.
7601	transaction is not under this service or service key is invalid	Returned when there is a mismatch with the service key or transaction.
7602	user presence failure	Returned when the user not available in the network.
7603	either validation failed for request or user verification failure	Returned when the validation is failed or user verification is failed for the request.