Skip to content

Client object fields

A client is an organization or a person your users talk to, identified by phone numbers. MiaRec associates call recordings with a client when a participant's number matches one of the client's contacts. Calls can then be filtered by client.

Example of a client object:

{
    "client": {
        "client_id": "34cbea90-9201-11e5-a932-e03f497dbdff",
        "tenant_id": "34c7f1f6-9201-11e5-a739-e03f497dbdff",
        "name": "Parker Group",
        "contacts": [
            {"phone_number": "+14085800150", "name": "Main number"},
            {"phone_number": "+14085800105", "name": "Fax"}
        ]
    }
}
Attribute Type Description
client_id UUID Unique ID of the client, assigned by MiaRec when the client is created. Read-only.
tenant_id UUID ID of the tenant the client belongs to. Available only when multi-tenancy is enabled, and returned only to administrators of the System tenant.
name string Client name. Required. 1 to 64 characters.
contacts list Contacts (phone numbers) of the client. At least one contact is required. See Contact object.

Contact object

Attribute Type Description
phone_number string Phone number, 1 to 64 characters. Required. MiaRec matches call recordings to the client by this number.
name string or null Contact name, for example the person this number belongs to. Up to 64 characters.