Every object the Partner API accepts or returns.
| Field |
Type |
Required |
Notes |
to |
string |
Yes |
— |
from |
string |
Yes |
— |
subject |
string |
No |
— |
text |
string |
No |
— |
html |
string |
No |
— |
A finished call, as the extension’s engine reports it (FinishedCall).
| Field |
Type |
Required |
Notes |
number |
string |
Yes |
min length 3 |
direction |
inbound / outbound |
Yes |
— |
started_at |
string |
Yes |
format date-time |
talked_seconds |
integer |
Yes |
Seconds SPOKEN. A missed call lasts 0. min 0 |
sip_status |
integer |
No |
— |
sip_callid |
string |
Yes |
The Call-ID from jambonz CDR. Also the idempotency key. min length 1 |
call_outcome |
answered / unanswered |
Yes |
— |
call_type |
cold / follow_up / other |
No |
default other |
notes |
string |
No |
— |
contact_point_id |
string |
Yes |
min length 1 |
links |
array of — |
No |
default [] |
| Field |
Type |
Required |
Notes |
target_type |
account / venue / contact / contact_point / lead |
Yes |
— |
target_id |
string |
Yes |
— |
What the salesperson adjusts on save: the type, the outcome and the notes.
| Field |
Type |
Required |
Notes |
call_type |
cold / follow_up / other |
No |
— |
call_outcome |
answered / unanswered |
No |
— |
notes |
string |
No |
— |
Payload sent by web-app’s /pay/resdiary page (camelCase).
| Field |
Type |
Required |
Notes |
bookingReference |
string |
Yes |
— |
bookingToken |
string |
Yes |
— |
paymentMethodId |
string |
Yes |
— |
intentType |
string |
No |
— |
paymentIntentId |
string |
No |
— |
| Field |
Type |
Required |
Notes |
status |
string |
Yes |
— |
bookingStatus |
string |
Yes |
— |
bookingReference |
string |
Yes |
— |
| Field |
Type |
Required |
Notes |
client_id |
string |
Yes |
— |
client_secret |
string |
Yes |
— |
grant_type |
string |
Yes |
— |
code |
string |
Yes |
— |
| Field |
Type |
Required |
Notes |
customer_id |
string |
Yes |
— |
destination_phone |
string |
Yes |
Phone number in E164 format pattern ^\+\d{5,15}$ |
message_type |
booking_created / booking_cancelled / booking_updated |
Yes |
— |
booking_data |
object |
Yes |
— |
| Field |
Type |
Required |
Notes |
detail |
array of — |
No |
— |
| Field |
Type |
Required |
Notes |
status |
string |
Yes |
— |
request_id |
string |
Yes |
— |
integration_ids |
array of string |
No |
— |
reason |
string |
No |
— |
| Field |
Type |
Required |
Notes |
contactPhone |
string |
Yes |
Phone number in E164 format |
queue |
string or integer |
Yes |
— |
mainPhone |
string |
Yes |
Phone number in E164 format |
| Field |
Type |
Required |
Notes |
id |
string |
Yes |
— |
status |
deleted / delivered / failed / read / sent / warning / created |
Yes |
Delivery status of a WhatsApp message. CREATED has been added by us to mark locally-created messages with no feedback status from WhatsApp yet. |
created |
string |
Yes |
format date-time |
| Field |
Type |
Required |
Notes |
message_id |
string |
Yes |
— |
| Field |
Type |
Required |
Notes |
client_id |
string |
Yes |
— |
client_secret |
string |
Yes |
— |
token |
string |
Yes |
— |
| Field |
Type |
Required |
Notes |
loc |
array of string or integer |
Yes |
— |
msg |
string |
Yes |
— |
type |
string |
Yes |
— |
input |
— |
No |
— |
ctx |
object |
No |
— |
Delivery status of a WhatsApp message.
CREATED has been added by us to mark locally-created messages with no
feedback status from WhatsApp yet.
No fields.
