Features
Company
Resources
© 2018 — 2024
API documentation
The Call object allows to record phone calls made with contacts. A call has to be associated with an existing contact - it can't be orphan.
A call has a called_at field that lets you record the date the call happened.
The called_at field must be a valid date according to the strtotime PHP
function.
When retrieving a call, we always also return some basic information about the related contact.
GET /calls/
| Name | Type | Description |
|---|---|---|
| limit | integer | Indicates the page size. |
| page | integer | Indicates the page to return. |
{
"data": [
{
"id": 3,
"object": "call",
"called_at": "2017-10-07T21:17:45Z",
"content": "He called, we had fun.",
"account": {
"id": 5
},
"contact": {
"id": 3,
"object": "contact",
"first_name": "Leslie",
"last_name": "Knope",
"gender": "none",
"is_partial": false,
"information": {
"dates": [
{
"name": "birthdate",
"is_birthdate_approximate": "unknown",
"birthdate": null
}
]
},
"account": {
"id": 5
}
},
"created_at": "2017-10-07T21:17:45Z",
"updated_at": "2017-10-07T21:17:45Z"
},
{
"id": 5,
"object": "call",
"called_at": "2017-10-07T22:29:21Z",
"content": "He called, we had fun and really awesome.",
"account": {
"id": 5
},
"contact": {
"id": 3,
"object": "contact",
"first_name": "Leslie",
"last_name": "Knope",
"gender": "none",
"is_partial": false,
"information": {
"dates": [
{
"name": "birthdate",
"is_birthdate_approximate": "unknown",
"birthdate": null
}
]
},
"account": {
"id": 5
}
},
"created_at": "2017-10-07T22:29:21Z",
"updated_at": "2017-10-07T22:29:56Z"
},
{
"id": 1,
"object": "call",
"called_at": "2017-10-07T21:00:56Z",
"content": "We talked about nice stuff\r\n* And especially about their wedding",
"account": {
"id": 5
},
"contact": {
"id": 3,
"object": "contact",
"first_name": "Leslie",
"last_name": "Knope",
"gender": "none",
"is_partial": false,
"information": {
"dates": [
{
"name": "birthdate",
"is_birthdate_approximate": "unknown",
"birthdate": null
}
]
},
"account": {
"id": 5
}
},
"created_at": "2017-10-07T21:00:56Z",
"updated_at": "2017-10-07T21:00:56Z"
},
{
"id": 2,
"object": "call",
"called_at": "2017-10-07T21:02:57Z",
"content": "Just laughed super hard.",
"account": {
"id": 5
},
"contact": {
"id": 1,
"object": "contact",
"first_name": "Henri",
"last_name": "Troyat",
"gender": "male",
"is_partial": false,
"information": {
"dates": [
{
"name": "birthdate",
"is_birthdate_approximate": "approximate",
"birthdate": "1987-01-01T21:56:44Z"
}
]
},
"account": {
"id": 5
}
},
"created_at": "2017-10-07T21:02:57Z",
"updated_at": "2017-10-07T21:02:57Z"
}
],
"links": {
"first": "https:\/\/app.monicahq.com\/api\/calls?page=1",
"last": "https:\/\/app.monicahq.com\/api\/calls?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "https:\/\/app.monicahq.com\/api\/calls",
"per_page": 10,
"to": 4,
"total": 4
}
}GET /contacts/:id/calls
{
"data": [
{
"id": 3,
"object": "call",
"called_at": "2017-10-07T21:17:45Z",
"content": "He called, we had fun.",
"account": {
"id": 5
},
"contact": {
"id": 3,
"object": "contact",
"first_name": "Leslie",
"last_name": "Knope",
"gender": "none",
"is_partial": false,
"information": {
"dates": [
{
"name": "birthdate",
"is_birthdate_approximate": "unknown",
"birthdate": null
}
]
},
"account": {
"id": 5
}
},
"created_at": "2017-10-07T21:17:45Z",
"updated_at": "2017-10-07T21:17:45Z"
},
{
"id": 1,
"object": "call",
"called_at": "2017-10-07T21:00:56Z",
"content": "We talked about nice stuff\r\n* And especially about their wedding",
"account": {
"id": 5
},
"contact": {
"id": 3,
"object": "contact",
"first_name": "Leslie",
"last_name": "Knope",
"gender": "none",
"is_partial": false,
"information": {
"dates": [
{
"name": "birthdate",
"is_birthdate_approximate": "unknown",
"birthdate": null
}
]
},
"account": {
"id": 5
}
},
"created_at": "2017-10-07T21:00:56Z",
"updated_at": "2017-10-07T21:00:56Z"
}
],
"links": {
"first": "https:\/\/app.monicahq.com\/api\/contacts\/3\/calls?page=1",
"last": "https:\/\/app.monicahq.com\/api\/contacts\/3\/calls?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "https:\/\/app.monicahq.com\/api\/contacts\/3\/calls",
"per_page": 10,
"to": 2,
"total": 2
}
}GET /calls/:id
{
"data": {
"id": 1,
"object": "call",
"called_at": "2017-10-07T21:00:56Z",
"content": "We talked about nice stuff\r\n* And especially about their wedding",
"account": {
"id": 5
},
"contact": {
"id": 3,
"object": "contact",
"first_name": "Leslie",
"last_name": "Knope",
"gender": "none",
"is_partial": false,
"information": {
"dates": [
{
"name": "birthdate",
"is_birthdate_approximate": "unknown",
"birthdate": null
}
]
},
"account": {
"id": 5
}
},
"created_at": "2017-10-07T21:00:56Z",
"updated_at": "2017-10-07T21:00:56Z"
}
}POST /calls/
| Name | Type | Description |
|---|---|---|
| content | string | Required. The description of the call. Max 100000 characters. |
| contact_id | integer | Required. The ID of the contact that the call is associated with. |
| called_at | string | Required. The date the call happened. Can be in the past or future - the latter being dumb, but well. Format: YYYY-MM-DD. |
{
"content": "He called, we had fun.",
"contact_id": 3,
"called_at": "2018-02-02"
}The API call returns a Call object if the call succeeds.
{
"data": {
"id": 5,
"object": "call",
"called_at": "2017-10-07T22:29:21Z",
"content": "He called, we had fun.",
"account": {
"id": 5
},
"contact": {
"id": 3,
"object": "contact",
"first_name": "Leslie",
"last_name": "Knope",
"gender": "none",
"is_partial": false,
"information": {
"dates": [
{
"name": "birthdate",
"is_birthdate_approximate": "unknown",
"birthdate": null
}
]
},
"account": {
"id": 5
}
},
"created_at": "2017-10-07T22:29:21Z",
"updated_at": "2017-10-07T22:29:21Z"
}
}PUT /calls/:id
| Name | Type | Description |
|---|---|---|
| content | string | Required. The description of the call. Max 100000 characters. |
| contact_id | integer | Required. The ID of the contact that the call is associated with. |
| called_at | string | Required. The date the called happened. Can be in the past or future - the latter being dumb, but well. Format: YYYY-MM-DD. |
{
"content": "He called, we had fun and really awesome.",
"contact_id": 3,
"called_at": "2018-02-02"
}{
"data": {
"id": 5,
"object": "call",
"called_at": "2017-10-07T22:29:21Z",
"content": "He called, we had fun and really awesome.",
"account": {
"id": 5
},
"contact": {
"id": 3,
"object": "contact",
"first_name": "Leslie",
"last_name": "Knope",
"gender": "none",
"is_partial": false,
"information": {
"dates": [
{
"name": "birthdate",
"is_birthdate_approximate": "unknown",
"birthdate": null
}
]
},
"account": {
"id": 5
}
},
"created_at": "2017-10-07T22:29:21Z",
"updated_at": "2017-10-07T22:29:56Z"
}
}DELETE /calls/:id
The response sends back the id that was just deleted.
{
"deleted": true,
"id": 31
}Features
Company
Resources
© 2018 — 2024