HOhootsuite
Inbox

Get status detail

Get the details of a message with a specific status.

get/inbox/v1/proactive-messaging/{correlationId}/{status}

Request

  • Base URL
    https://platform.hootsuite.com
  • URL
    https://platform.hootsuite.com/inbox/v1/proactive-messaging/{correlationId}/{status}
  • Auth
    OAuth 2
    Authorization code: https://platform.hootsuite.com/oauth2/auth
    Token URL: https://platform.hootsuite.com/oauth2/token

Path parameters

correlationIdstring required
status'PROCESSING' | 'FAILED' | 'SENT' | 'DELIVERED' | 'DELIVERING_FAILED' required

Response

Success

statusstring

The status of the message

contactstring

The contact used to send the message to

reasonstring

The reason of failure

Example response

[
  {
    "status": "FAILED",
    "contact": "+32495123456",
    "reason": "No channel found for medium WHATSAPP"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.