Get a single WhatsAppMessage activity

GET

https://api.close.com/api/v1/activity/whatsapp_message/:id/

GET

/api/v1/activity/whatsapp_message/:id/

$ curl https://api.close.com/api/v1/activity/whatsapp_message/id/ \
>      -u "<CLOSE_API_KEY>:"

1 {
2   "_type": "WhatsAppMessage",
3   "activity_at": "2013-02-01T01:06:35.668000+00:00",
4   "contact_id": "cont_q4xYmlGhA3060dEl0NDJuHRxPMuVjqLn30AFSzh1fRk",
5   "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
6   "date_created": "2013-02-01T01:05:04.070000+00:00",
7   "date_updated": "2013-02-01T01:06:35.668000+00:00",
8   "direction": "outgoing",
9   "external_whatsapp_message_id": "1234567890",
10   "id": "acti_asjiweURMfsLgKuYGqbQ4Qp7L5a16pQOcDfTgotqDak",
11   "integration_link": "https://example.com/messages/1234567890",
12   "integration_name": "API",
13   "lead_id": "lead_KwD00BYbXCHiPWj68LxFkxaeWuULpZ7awzm6LqeFs0h",
14   "local_phone": "+16503334444",
15   "local_phone_formatted": "+1 650-333-444",
16   "message_html": "<p>test</p>",
17   "message_markdown": "test",
18   "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
19   "remote_phone": "+18183004000",
20   "remote_phone_formatted": "+1 818-300-4000",
21   "response_to_id": "acti_asjiweURMfsLgKuYGqbQ4Qp7L5a16pQOcDfTgotqDak",
22   "source": "api",
23   "text": "test",
24   "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
25   "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
26   "users": [],
27   "attachments": [],
28   "created_by_name": "Stefan Wójcik",
29   "updated_by_name": "Stefan Wójcik"
30 }

curl https://api.close.com/api/v1/activity/whatsapp_message/id/ \
     -u "<CLOSE_API_KEY>:"

{
  "_type": "WhatsAppMessage",
  "activity_at": "2013-02-01T01:06:35.668000+00:00",
  "contact_id": "cont_q4xYmlGhA3060dEl0NDJuHRxPMuVjqLn30AFSzh1fRk",
  "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "date_created": "2013-02-01T01:05:04.070000+00:00",
  "date_updated": "2013-02-01T01:06:35.668000+00:00",
  "direction": "outgoing",
  "external_whatsapp_message_id": "1234567890",
  "id": "acti_asjiweURMfsLgKuYGqbQ4Qp7L5a16pQOcDfTgotqDak",
  "integration_link": "https://example.com/messages/1234567890",
  "integration_name": "API",
  "lead_id": "lead_KwD00BYbXCHiPWj68LxFkxaeWuULpZ7awzm6LqeFs0h",
  "local_phone": "+16503334444",
  "local_phone_formatted": "+1 650-333-444",
  "message_html": "<p>test</p>",
  "message_markdown": "test",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "remote_phone": "+18183004000",
  "remote_phone_formatted": "+1 818-300-4000",
  "response_to_id": "acti_asjiweURMfsLgKuYGqbQ4Qp7L5a16pQOcDfTgotqDak",
  "source": "api",
  "text": "test",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "users": [],
  "attachments": [],
  "created_by_name": "Stefan Wójcik",
  "updated_by_name": "Stefan Wójcik"
}

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Response

Successful response

_typestring

activity_atdatetime or null

contact_idstring or null

created_bystring or null

date_createddatetime

date_updateddatetime

directionenum

Direction of communication. Outgoing means the communication flowing from the user to the lead/contact. Inbound means the opposite.

Allowed values:

external_whatsapp_message_idstring

idstring

integration_linkstring or null

integration_namestring or null

lead_idstring or null

local_phonestring

local_phone_formattedstring

message_htmlstring

message_markdownstring

organization_idstring

remote_phonestring

remote_phone_formattedstring

response_to_idstring or null

sourceenum

textstring

updated_bystring or null

user_idstring or null

userslist of strings

attachmentslist of objects

created_by_namestring or null

sequence_idstring or null

sequence_namestring or null

sequence_subscription_idstring or null

updated_by_namestring or null

user_namestring or null

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

$	curl https://api.close.com/api/v1/activity/whatsapp_message/id/ \
>	-u "<CLOSE_API_KEY>:"

1	{
2	"_type": "WhatsAppMessage",
3	"activity_at": "2013-02-01T01:06:35.668000+00:00",
4	"contact_id": "cont_q4xYmlGhA3060dEl0NDJuHRxPMuVjqLn30AFSzh1fRk",
5	"created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
6	"date_created": "2013-02-01T01:05:04.070000+00:00",
7	"date_updated": "2013-02-01T01:06:35.668000+00:00",
8	"direction": "outgoing",
9	"external_whatsapp_message_id": "1234567890",
10	"id": "acti_asjiweURMfsLgKuYGqbQ4Qp7L5a16pQOcDfTgotqDak",
11	"integration_link": "https://example.com/messages/1234567890",
12	"integration_name": "API",
13	"lead_id": "lead_KwD00BYbXCHiPWj68LxFkxaeWuULpZ7awzm6LqeFs0h",
14	"local_phone": "+16503334444",
15	"local_phone_formatted": "+1 650-333-444",
16	"message_html": "<p>test</p>",
17	"message_markdown": "test",
18	"organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
19	"remote_phone": "+18183004000",
20	"remote_phone_formatted": "+1 818-300-4000",
21	"response_to_id": "acti_asjiweURMfsLgKuYGqbQ4Qp7L5a16pQOcDfTgotqDak",
22	"source": "api",
23	"text": "test",
24	"updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
25	"user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
26	"users": [],
27	"attachments": [],
28	"created_by_name": "Stefan Wójcik",
29	"updated_by_name": "Stefan Wójcik"
30	}