go back Home

CarrierDriverMessageService

This service provides methods for viewing and sending driver text messages.

Operations

name description
GET /carrierDriverMessages Gets all driver text messages matching the request criteria. If no criteria given, then all driver text messages for the current company are returned. For example, /carrierDriverMessages?order_id=0256189 would find driver text messages for order 0256189.
GET /carrierDriverMessages/previewMessage Retrieves the composed message.
GET /carrierDriverMessages/{id} Retrieves the driver text message based on the specified ID.
GET /carrierDriverMessages/{id}/thumbnail Retrieves a PNG thumbnail of the attachment stored with a message, if it exists.
POST /carrierDriverMessages/sendMessage Sends the composed message and updates certain records (carrier_driver, order_post_hist, and movement) based on the supplied query parameters.
POST /carrierDriverMessages/{id}/messageRead Updates the driver text message with the specified ID as read or unread.
POST /carrierDriverMessages/{id}/resend Resends the driver text message with the specified ID.
POST /carrierDriverMessages/{id}/updateStatus Updates the status of the driver text message with the specified ID.