ПланФикс API contact.getPhoneTypes: различия между версиями
Материал из Planfix
Seva (обсуждение | вклад) (Новая страница: «Функция позволяет получить список доступных типов телефонных номеров. Формат вызова фу…») |
Alice (обсуждение | вклад) Нет описания правки |
||
Строка 1: | Строка 1: | ||
{{#seo: | |||
|title=ПланФикс API contact.getPhoneTypes | |||
|titlemode=append | |||
|keywords=планфикс, апи, api | |||
|description=ПланФикс API contact.getPhoneTypes | |||
}} | |||
Функция позволяет получить список доступных типов телефонных номеров. Формат вызова функции: | Функция позволяет получить список доступных типов телефонных номеров. Формат вызова функции: | ||
<source lang="xml"> | <source lang="xml"> |
Текущая версия от 12:46, 9 декабря 2017
Функция позволяет получить список доступных типов телефонных номеров. Формат вызова функции:
<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.getPhoneTypes">
<account></account>
<sid></sid>
<signature></signature>
</request>
Название | Тип | Значение | Примечание |
---|---|---|---|
signature | string(32) | md5 от имени функции, значений всех полей, исключая signature | подробное описание алгоритма формирования подписи смотри в разделе ПланФикс API:Формирование цифровой подписи |
Ответ:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<phoneTypes totalCount="x">
<phoneType>
<id></id>
<name></name>
</phoneType>
<phoneType>
<id></id>
<name></name>
</phoneType>
<!-- -->
</phoneTypes>
</response>
Название | Тип | Значение | Примечание |
---|---|---|---|
phoneTypes | списоктипов телефонных номеров | ||
phoneTypes totalCount | int | количество элементов в списке | |
phoneType | корневой элемент описывающий тип телефонного номера | ||
phoneType.id | int | идентификатор | |
phoneType.name | string | название |
В противном случае будет возвращен ответ с ошибкой:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>