messages

Busca uma mensagem pelo ID interno

get/v1/messages/{internalId}

Path parameters

internalIdstring required

ID interno da mensagem (formato ara_msg_*).

Response

Mensagem encontrada

idstring nullable
status'PENDING' | 'SCHEDULED' | 'PROCESSING' | 'SENT' | 'DELIVERED' | 'READ' | 'FAILED' | 'CANCELED' required
mode'LIVE' required
senderstring required
receiverstring required
bodystring nullable
costnumber float nullable

Example response

{
  "status": "SENT"
}

Changes

Changed in 2 of the 4 revisions of this API.4810

  • 174c89e36a1381See the full diff
    • added the new CANCELED enum value to the response property for the response status

      response-property-enum-value-added

    • added the new DELIVERED enum value to the response property for the response status

      response-property-enum-value-added

    • added the new FAILED enum value to the response property for the response status

      response-property-enum-value-added

    • added the new PENDING enum value to the response property for the response status

      response-property-enum-value-added

    • added the new PROCESSING enum value to the response property for the response status

      response-property-enum-value-added

    • added the new READ enum value to the response property for the response status

      response-property-enum-value-added

    • added the new SCHEDULED enum value to the response property for the response status

      response-property-enum-value-added

    • added the new SENT enum value to the response property for the response status

      response-property-enum-value-added

    • removed the TEST enum value from the response property for the response status

      response-property-enum-value-removed

  • 4e426b85f78449See the full diff
    • the response property became nullable for the status

      response-property-became-nullable

    • the response property became nullable for the status

      response-property-became-nullable

    • the response property became nullable for the status

      response-property-became-nullable

    • the response's property format changed from decimal to float for status

      response-property-type-changed

    • api tag messages added

      api-tag-added

    • api tag Messages removed

      api-tag-removed

    • added the media type application/json for the response with the status

      response-media-type-added

    • added the media type application/json for the response with the status

      response-media-type-added

    • added the non-success response with the status

      response-non-success-status-added

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    • the response property became required for the status

      response-property-became-required

    This revision also has 24 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog