- get all contacts, possible filltered by url query string
Headers:
Authorization: bearer <your auth.token here> (how to get token see user operations)
Accept or Content-Type specifies response content format: application/json, text/xml.
Optional filters(via URL,URL filter keywords are case sensitive!):
acceptBillingNotifications - True - search for contacts which accepts billing notifications, False - search only for contacts which does not accept billing notifications, Null - search both
GET https://www.host-tracker.com/api/web/v1/contacts?acceptBillingNotifications=True HTTP/1.1
User-Agent: Fiddler
Content-Type: application/json
Host: www.host-tracker.com
Authorization: bearer <your token here>
address - search for contacts with specified address.
GET https://www.host-tracker.com/api/web/v1/contacts?address=test@mail.com HTTP/1.1
User-Agent: Fiddler
Content-Type: application/json
Host: www.host-tracker.com
Authorization: bearer <your token here>
addresses - search for contacts with specified addresses
GET https://www.host-tracker.com/api/web/v1/contacts?addresses=test@mail.com&addresses= 1122334455 HTTP/1.1
User-Agent: Fiddler
Content-Type: application/json
Host: www.host-tracker.com
Authorization: bearer <your token here>
overlimited - True - search for overlimited only, False - search only for not overlimited, Null - search both.
GET https://www.host-tracker.com/api/web/v1/contacts?overlimited=False HTTP/1.1
User-Agent: Fiddler
Content-Type: application/json
Host: www.host-tracker.com
Authorization: bearer <your token here>
- contact data
Content-Type: application/json
[
{
"id":"Contact id",
"address":"Contact address",
"confirmed":"True or false"
"contactType":"Type of contact",
"name":"Name of contact",
"sendCost":"Cost to send",
"alertDelay":"Delay of alert",
"activePeriodStart":"Start of active period",
"activePeriodEnd":"End of active period",
"activeDays":"Active days",
"billingOverlimit":Billing overlimit here,
"subscriptions":"Subscriptions here",
"reportFormat":"Format of report",
"sendNews":"True or false",
"sendPressRelease":"True or false",
"sendBillingNotifications":"True or false"
}
]
Content-Type: text/xml
<ArrayOfContact xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Contact xsi:type="EmailContact">
<id>Contact id</id>
<confirmed>True or false</confirmed>
<contactType>Type of contact</contactType>
<name>Name</name>
<address>Contact address</address>
<sendCost>Cost to send</sendCost>
<alertDelay>Delay of alerts</alertDelay>
<activePeriodStart />
<activePeriodEnd />
<billingOverlimit />
<subscriptions />
<reportFormat>Format of report</reportFormat>
<sendNews>True or false</sendNews>
<sendPressRelease>True or false</sendPressRelease>
<sendBillingNotifications>True or false</sendBillingNotifications>
</Contact>
</ArrayOfContact>
- get contact by id (GUID)
Headers:
Authorization: bearer <your auth.token here> (how to get token see user operations)
Authorization: bearer <your auth.token here> (how to get token see user operations)
Accept or Content-Type specifies response content format: application/json, text/xml. Parameters:
id - contact id (GUID) should be specified only in UpdateContacts operation. For other method should be null (not set).
name - user provided contact name
address - contact address
alertDelay - alert sending delay in minutes. See GetAlertDelays method for available values
activePeriodStart - string in format hh:mm (or null if contact is active for all time), specify start of contact daily activity period.
Should be specified with activePeriodEnd. If activePeriodStart > activePeriodEnd then activity period calculated as
period from activePeriodStart day time to the end of the day plus period from next day start to next day activePeriodEnd time.
If alert created when contact is outside activity period then it will not be sent to this contact.
activePeriodEnd - string in format hh:mm (or null if contact is active for all time), specify period of contact activity.
Should be specified with activePeriodStart. If activePeriodStart > activePeriodEnd then activity period calculated as
period from activePeriodStart day time to the end of the day plus period from next day start to next day activePeriodEnd time.
If alert created when contact is outside activity period then it will not be sent to this contact.
activeDays - array of week days when contact is active or null if contact is active for all days. Available values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
subscriptions - subscriptions for this contact (see subscription service AddSubscriptions for details).
reportFormat - format of emails. Currently supported: Text, ShortText. Planned: HTML, Pdf(for reports)
sendNews - could contact be used for news delivery
sendPressRelease - could contact be used for press release delivery
Content-Type: application/json
{"address":"example@example.com","name":"name of you contact"}
Content-Type: text/xml
<EmailContactEditableData>
<address> example@example.com
</address>
<name> name of your contact
</name>
</EmailContactEditableData>
Contact statuses:
Confirmed - contact created in confirmed state.
LowSmsBalance - could not send contact confirmation code due to low balance.
CodeSent - contact created and confirmation code was sent. Contact become active after confirmation.
CodeFail - contact create but code sending failed. Try to resend code after some time.
CodeSentEarlier -
OperationError -
Overlimited -
- create sms contact
Headers:
Authorization: bearer <your auth.token here> (how to get token see user operations)
Accept or Content-Type specifies response content format: application/json, text/xml. Parameters:
id - contact id (GUID) should be specified only in UpdateContacts operation. For other method should be null (not set).
name - user provided contact name
address - contact address
alertDelay - alert sending delay in minutes. See GetAlertDelays method for available values
activePeriodStart - string in format hh:mm (or null if contact is active for all time), specify start of contact daily activity period.
Should be specified with activePeriodEnd. If activePeriodStart > activePeriodEnd then activity period calculated as
period from activePeriodStart day time to the end of the day plus period from next day start to next day activePeriodEnd time.
If alert created when contact is outside activity period then it will not be sent to this contact.
activePeriodEnd - string in format hh:mm (or null if contact is active for all time), specify period of contact activity.
Should be specified with activePeriodStart. If activePeriodStart > activePeriodEnd then activity period calculated as
period from activePeriodStart day time to the end of the day plus period from next day start to next day activePeriodEnd time.
If alert created when contact is outside activity period then it will not be sent to this contact.
activeDays - array of week days when contact is active or null if contact is active for all days. Available values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
subscriptions - subscriptions for this contact (see subscription service AddSubscriptions for details).
Content-Type: application/json
{"address":"number","name":"name of you contact","gateway":"type of gateway"}
Content-Type: text/xml
<SmsContactEditableData>
<address>399494543</address>
<name>name of you contact4</name>
<gateway>clickatell</gateway>
</SmsContactEditableData>
Contact data
- create instant messaging contact
Headers:
Authorization: bearer <your auth.token here> (how to get token see user operations)
Accept or Content-Type specifies response content format: application/json, text/xml. Parameters:
id - contact id (GUID) should be specified only in UpdateContacts operation. For other method should be null (not set).
name - user provided contact name
address - contact address
alertDelay - alert sending delay in minutes. See GetAlertDelays method for available values
activePeriodStart - string in format hh:mm (or null if contact is active for all time), specify start of contact daily activity period.
Should be specified with activePeriodEnd. If activePeriodStart > activePeriodEnd then activity period calculated as
period from activePeriodStart day time to the end of the day plus period from next day start to next day activePeriodEnd time.
If alert created when contact is outside activity period then it will not be sent to this contact.
activePeriodEnd - string in format hh:mm (or null if contact is active for all time), specify period of contact activity.
Should be specified with activePeriodStart. If activePeriodStart > activePeriodEnd then activity period calculated as
period from activePeriodStart day time to the end of the day plus period from next day start to next day activePeriodEnd time.
If alert created when contact is outside activity period then it will not be sent to this contact.
activeDays - array of week days when contact is active or null if contact is active for all days. Available values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
subscriptions - subscriptions for this contact (see subscription service AddSubscriptions for details).
Authorization: bearer <your auth.token here> (how to get token see user operations)
Accept or Content-Type specifies response content format: application/json, text/xml. Parameters:
id - contact id (GUID) should be specified only in UpdateContacts operation. For other method should be null (not set).
name - user provided contact name
address - contact address
alertDelay - alert sending delay in minutes. See GetAlertDelays method for available values
activePeriodStart - string in format hh:mm (or null if contact is active for all time), specify start of contact daily activity period.
Should be specified with activePeriodEnd. If activePeriodStart > activePeriodEnd then activity period calculated as
period from activePeriodStart day time to the end of the day plus period from next day start to next day activePeriodEnd time.
If alert created when contact is outside activity period then it will not be sent to this contact.
activePeriodEnd - string in format hh:mm (or null if contact is active for all time), specify period of contact activity.
Should be specified with activePeriodStart. If activePeriodStart > activePeriodEnd then activity period calculated as
period from activePeriodStart day time to the end of the day plus period from next day start to next day activePeriodEnd time.
If alert created when contact is outside activity period then it will not be sent to this contact.
activeDays - array of week days when contact is active or null if contact is active for all days. Available values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
subscriptions - subscriptions for this contact (see subscription service AddSubscriptions for details).
Currently has no additional field. VoiceCall gateway is twiliovoice. Send cost: $0.04 for US carriers, $0.222 for other.
Authorization: bearer <your auth.token here> (how to get token see user operations)
Accept or Content-Type specifies response content format: application/json, text/xml.
Content-Type: application/json
PUT https://www.host-tracker.com/api/web/v1/contacts/email/id of contact HTTP/1.1
User-Agent: Fiddler
Content-Type: application/json
Host: www.host-tracker.com
Authorization: bearer your ticket here
{"reportFormat":"ShortText"}
Content-Type: text/xml
PUT https://www.host-tracker.com/api/web/v1/contacts/email/id of contact HTTP/1.1
User-Agent: Fiddler
Content-Type: text/xml
Host: www.host-tracker.com
Authorization: bearer your ticket here
<EmailContactEditableData>
<reportFormat>report format, see</reportFormat>
<sendNews>1 or 0</sendNews>
</EmailContactEditableData>
Contact data
- update sms contact
Headers:
Authorization: bearer <your auth.token here> (how to get token see user operations)
Accept or Content-Type specifies response content format: application/json, text/xml.
Currently has no additional field. VoiceCall gateway is twiliovoice. Send cost: $0.04 for US carriers, $0.222 for other.
- delete contact specified by id (GUID)
Headers:
Authorization: bearer <your auth.token here> (how to get token see user operations)
Accept or Content-Type specifies response content format: application/json, text/xml.
DELETE https://www.host-tracker.com/api/web/v1/contacts/id of contact HTTP/1.1
User-Agent: Fiddler
Content-Type: application/json
Host: www.host-tracker.com
Authorization: bearer your ticket here
Contact data
- delete contacts specified by filter or all contacts
Contact data
- confirm contact by sending confirmation code
Headers:
Authorization: bearer <your auth.token here> (how to get token see user operations)
Accept or Content-Type specifies response content format: application/json, text/xml.
Content-Type: application/json
POST https://www.host-tracker.com/api/web/v1/contacts/id of contact/code HTTP/1.1
User-Agent: Fiddler
Content-Type: application/json
Host: www.host-tracker.com
Authorization: bearer your token here