#Search messages
Get all the unreplied messages.
#Method
GET
#Path
/messages/search
#Query string parameter
Name | Value | Required? | Remarks |
---|---|---|---|
text | Search term | Yes | - |
direction | incoming (Search incoming messages only), outbound (Search outgoing messages only), both (Search all messages) | No | Defaults to both |
start_date | Date in YYYY-MM-DD format (e.g., 2024-01-01 ) | No | Defaults to 90 days before today. Results include given date. |
end_date | Date in YYYY-MM-DD format (e.g., 2024-01-31 ) | No | Defaults to today. Results include given date. |
#Response
#HTTP status codes
Code | Remarks |
---|---|
200 | Request was successful. |
400 | Validation error or request body was incorrectly formatted. |
401 | Authentication failed. Check apikey header. |
404 | Requested API endpoint not found. |
429 | The rate limit has been reached. |
500-511 | There was a problem processing the request on our server. Try again later. |
#Response object
Name | Value | Remarks |
---|---|---|
status | success or error | - |
errors | Array of object { msg: [error detail] } | Only present when status is error . |
data | Array of message objects | Only present when status is success |
#Code sample
curl --location --request GET 'https://api.sociocs.com/messages/search?text=interested' \ --header 'apikey: your_api_key' \