action bulksms_get_messages_id { label: "Show Message" description: "Get a the message by `id`.\n```http\nGET /v1/messages/4023457654\n```\n" provider: bulksms method: GET path: "/messages/{id}" encoding: json input: { type: "object" properties: { id: { type: "string" } } required: ["id"] additionalProperties: false } output: { type: "object" required: ["body", "id", "status", "to", "type"] properties: { body: { description: "The content of the message" type: "object" } creditCost: { type: "number" format: "float" description: "The cost of the message (in credits). Note that this field does not have a value in the submission response." } encoding: { type: "string" description: "The type of the content. See the `encoding` field for more information." enum: ["TEXT", "UNICODE", "BINARY"] } from: { type: "string" description: "The address part of the sender id" } id: { type: "string" description: "A unique identifier that is assigned when the message is created." } messageClass: { type: "integer" format: "int32" description: "See the `messageClass` field for more information." } numberOfParts: { type: "integer" format: "int32" description: "The number of parts. If this is a concatenated message, the number of parts will be more than 1. Note that this field does not have a value in the submission response." } protocolId: { type: "integer" format: "int32" description: "See the `protocolId` field for more information." } relatedSentMessageId: { type: "string" description: "This field has a value only if the type is RECEIVED.\nWith SMS messages, it is not possible to link a reply directly with a specific sent message. However, if you specified `REPLIABLE` in the `from` property, BulkSMS will link any reply to the most recent message sent to a given phone number.\n\nThe `relatedSentMessageId` property keeps the information about this link.\n\nYou can use this property to derive an implicit conversation from a set of messages.\n - If a received reply message has a `relatedSentMessageId`, you can use it to retrieve the last message that was sent before the reply was received.\n - If you have the `id` of the sent message and you want all the received messages that relate to it, you can use the List Related Messages Operation.\n" } status: { type: "object" description: "The status of the message" required: ["id", "type"] properties: { id: { type: "string" description: "A concatenated value A.B where A is the `status.type` and B is the `status.subtype`. \nIt there is no value for `subtype` then B takes string value `\"null\"` (e.g. `\"SENT.null\"`). \n" } subtype: { type: "string" description: "Has a value only if the `type` is FAILED.\n\nEXPIRED Delivery failed because message expired before delivery was possible.\n\nHANDSET_ERROR Delivery failed because of a problem related to the phone (e.g. message storage area full).\n\nBLOCKED Your account has been blocked from sending to this phone (e.g. recipient replied STOP to block communication).\n\nNOT_SENT Message delivery was not attempted (e.g. because we were not able to find a route for the supplied phone number).\n" enum: ["EXPIRED", "HANDSET_ERROR", "BLOCKED", "NOT_SENT"] } type: { type: "string" description: "\nACCEPTED Message accepted for delivery. Only returned for initial message submissions.\n\nSCHEDULED Message accepted for delivery at a later date. Only returned for initial message submissions.\n\nSENT Message has been relayed away from our systems.\n\nDELIVERED Successfully delivered to phone.\n\nUNKNOWN Message is in an unknown state.\n\nFAILED Delivery failed.\n" enum: ["ACCEPTED", "SCHEDULED", "SENT", "DELIVERED", "UNKNOWN", "FAILED"] } } } submission: { type: "object" description: "Identifies the submission.\n" required: ["date", "id"] properties: { date: { type: "string" format: "date-time" description: "The date and time the submission was processed. If the `type` is RECEIVED, this field reflects the date and time the received message was processed." } id: { type: "string" description: "A unique identity shared by all messages that were created from the same submission. This field should be ignored if the `type` is not SENT." } } } to: { type: "string" description: "The phone number of the recipient" } type: { type: "string" description: "The message direction" enum: ["SENT", "RECEIVED"] } userSuppliedId: { type: "string" description: "This is the value you supplied in the `userSuppliedId` field.\nHas a value only if the `type` is SENT.\n" } } } }