Skip to content

Client object fields

Example of JSON representation:

{
    "client":
    {
        "name": "MiaRec",
        "client_id": "34cbea90-9201-11e5-a932-e03f497dbdff",
        "tenant_id": "34c7f1f6-9201-11e5-a739-e03f497dbdff",
        "contacts": [{
            "phone_number": "+14085800150",
            "name": "Main number"
        }, {
            "phone_number": "+14085800105",
            "name": "Fax"
        }]
    }
}
Field Type Description
name string Client name.
client_id UUID Unique ID of client assigned by MiaRec when client is created.
tenant_id UUID ID of parent tenant object. This field is available only when multi-tenancy is enabled in MiaRec.
contacts list

A of contacts (phone numbers). See object Contact below.

At least one contact is required.

Contact object fields

Field Type Description
phone_number string

Phone number associated with contact.

MiaRec application uses phone number to associate call recordings to clients.

Required.

name string

Contact name, for example a name of person this phone number belongs to.

Optional.