This API method is used to show whether an attachment is opened or not by the receiver.
| Parameter | Required | Type | Description |
|---|---|---|---|
| apikey | yes | string | Your authorized API key |
| secret | yes | string | Your authorized secret key |
| user_id | yes | string | Unique Id for user |
| business_id | yes | string | Unique Id for workspace |
| text_id | yes | string | Unique Id for text |
| contact_id | yes | string | Unique Id for contact |
{
"status": "success",
"status_code": 200,
"message": "Text timeline list.",
"result": [attachemnt objects]
}
| Error Code | Description |
|---|---|
| 701 | User id parameter required |
| 702 | User id is required |
| 701 | Business id parameter required |
| 702 | Business id required |
| 610 | Invalid user id |
| 610 | Invalid business id |
| 613 | Invalid user and business |
| 701 | Text Id parameter required |
| 701 | Contact Id parameter required |
{
"error": {
"reason": "parameter missing",
"message": "User id parameter required",
"field_name": "user_id",
"code": 701,
"error_type": "missing_parameter"
}
}
{
"error": {
"reason": "required field",
"message": "User id is required",
"code": 702,
"error_type": "required"
}
}
{
"error": {
"reason": "parameter missing",
"message": "Business id parameter required",
"field_name": "business_id",
"code": 701,
"error_type": "missing_parameter"
}
}
{
"error": {
"reason": "required field",
"message": "Business id required",
"code": 702,
"error_type": "required"
}
}
{
"error": {
"errors": [
{
"reason": "Invalid Id",
"message": "Please make sure you have provided the valid user id"
}
],
"code": 610,
"error_type": "reference_error"
}
}
{
"error": {
"errors": [
{
"reason": "Invalid Id",
"message": "Please make sure you have provided the valid business id"
}
],
"code": 610,
"error_type": "reference_error"
}
}
{
"error": {
"errors": [
{
"reason": "Invalid user and business",
"message": "The business and user id combination that you provided doesn't match in our record"
}
],
"code": 613,
"error_type": "invalid_user_business"
}
}
{
"error": {
"reason": "parameter missing",
"message": "Text id parameter required",
"field_name": "text_id",
"code": 701,
"error_type": "missing_parameter"
}
}
{
"error": {
"reason": "parameter missing",
"message": "Contact id parameter required",
"field_name": "contact_id",
"code": 701,
"error_type": "missing_parameter"
}
}
Loading please wait...
