Sending and Retrieving Messages
When you receive a work order, you can communicate with a customer by using text messages.
WebHook notification availableFor details about notification content, see
Message received.
Retrieving messages
To get a list of all work order messages, use GET/api/messages method. As a result, you will get a list of TextMessage items.
To distinguish between customer and associate messages, review the Sender.Type property value.
Message visibility
- Message list for CorrigoPro Desktop and CorrigoPro Direct are different.
- No automatically generated messages, such as a system message with a work description, are sent to CorrigoPro Direct.
- Only messages sent to CorrigoPro Desktop with visibility option set to All (Customer In), are sent to CorrigoPro Direct.
Sending messages
Both customer and CorrigoPro Desktop receive messages.
To send a message to a work order, call the POST/api/messagesmethod.
MessageVisibilityThe MessageVisibility parameter functions allows you to determine who may view the message:
- All if you want your Cru and the customer to see the message.
- CruOnly if you only want the message to be visible to your Cru and not the customer.
- CruLeads will provide visibility to your customer and your CruLeads.
- CruSubs allows you to send a message between you and your sub, without the customer seeing it.
- None Not visible anywhere.
Messages to your customerPlease be mindful of the fact that whenever you send a message that is visible to your customer, this creates a flag that they must clear on their system. When you are automating messages, ensure that the messages that the customer receives are messages that they need or want to see. They may become unhappy with having to clear flags for what they deem an excessive number of messages.
Important
Search Messages
The Message Search API allows you to retrieve a list of messages exchanged within the CorrigoPro system based on specified search criteria. This endpoint is useful for tracking communications related to work orders, customers, or branches, including details such as message content, sender information, and timestamps.
To search messages, call the endpoint atPOST/api/messages/search
This method returns a list of messages based on the specified search criteria. Search criteria can include a work order, customer, branch, or a date range for when the message was sent. Multiple criteria can be combined to narrow down the results returned.
Updated 20 days ago
