Developers API
getContactList
Query a list of all contact persons, and all alert channels configured for those contacts.
This is the result of a query joining our 'contact' and 'contact-channel' tables.
Request Parameters
This API command does not accept any parameters.
Response Data
| Response Variable | Data Type | Description |
|---|---|---|
| errorcode | integer | Returns an errorcode of 0 if call is successful. |
| contacts | This is an array - its' contents follow: | |
| contactid | integer | The ID of the contact person |
| contactname | string | The name given to this contact person |
| contactchannelid | integer | The unique ID identifying this person - channel tuple |
| channelid | integer | The ID specifying the type of contact channel (1 = email, 2 = sms, etc) |
| target | string | The address of the recipient; i.e. email, phone number, URL, depending on the channel |