Категории

Получить контакт по ID

Метод позволяет получить подробную информацию о существующем контакте, который содержится в системе, а также пользовательские поля контакта.

Чтобы получить контакт, сделайте запрос по этому URL:

GET http://one-api.notificore.ru/api/contacts/{id}


Request parameters

Parameter Required Type Description
id Yes integer ID of the contact to get information on (the contact ID is generated automatically by the Notificore system when a contact is added).


Response parameters

Parameter Type Description
id integer Contact ID on which the query for information was made.
phone integer Contact phone number.
fields array Contains the embedded custom fields parameters.
created_at datetime Contact creation date ― set automatically by the Notificore system when a contact is added to the Contact Book. Display format ― Y-m-d H:i:s
groups array Contains embedded parameters of the list to which the contact is added.
hlr_status string Status of verifying the contact’s phone number against the HLR database. Possible values: sent, absent, active, unknown, failed.
hlr_last_check datetime Date and time when the contact’s phone number was last verified against the HLR database. Display Format ― Y-m-d H:i:s

Если запрос успешен, вы получите ответ: 

{
    "data": {
        "id": 1,
        "phone": 33601148802,
        "fields": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
        },
        "created_at": "2022-04-28 14:21:16",
        "groups": [
            {
                "id": 1,
                "name": "string",
                "description": "string",
                "default": 0,
                "created_at": "2022-04-28 14:21:16"
            }
        ],
        "hlr_status": "string",
        "hlr_last_check": "2022-04-28 14:21:16"
    }
}

API Notificore предоставляет вам возможность управлять контактами для последующего использования в одиночных и массовых рассылках SMS, Viber или проверке номеров. Вы можете создавать новые контакты, просматривать, редактировать, группировать и удалять существующие контакты.