Planfix API contact.getPhoneTypes

From Planfix
Revision as of 09:24, 6 March 2024 by Dmitri (talk | contribs) (→‎Go To)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This function allows you to get a list of available phone number types. Request format:

<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.getPhoneTypes">
  <account></account>
  <sid></sid>
  <signature></signature>
</request>
Name Type Value Note
signature string(32) md5 from the function name, values of all fields, excluding signature for a detailed description of the signature formation algorithm, see section Planfix API:Creating a digital signature


Response:

<?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>
Name Type Value Note
phoneTypes list of phone number types
phoneTypes totalCount int number of items in the list
phoneType root element describing the phone number type
phoneType.id int identifier
phoneType.name string name


Otherwise, a response with an error will be returned:

<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>


Go To