Phone calls leads synchronization service
Partners that need to report phone calls leads can write a webservice using these specifications.
Get start
You are free to publish your entry point URLs, just need to inform us and
listening on http POST
method.
Entry point
We need to know the URL
[POST] https://partner.com/service-name/phone
Request Header
Anytime we push a lead we will send these http headers:
Content-type: application/json
Accept: application/json
Request body
Any push will have this JSON request body
:
{
"agencyEmail": "nobody@nowhere.net",
"agencyExternalId": "1234",
"agencyId": 5678,
"callFrom": "+393451234567",
"callTo": "+39061234567",
"date": "2021-03-05 01:25:02",
"duration": 0,
"listingId": 87654321,
"listingExternalId":"ES-RIF-001",
"outcome": "ABORTED",
"phoneCallId": 10000001,
"src": "immobiliare.it"
}
Attribute outcome
contains one of these values:
ANSWER: phone call ended with success
ABORTED: phone call broken by user
LOST_CALL: no answer
BUSY: busy line
Response
Your service need to answer with a http status code:
any response
with a 2xx class status code is a success.
On the response
body we need a JSON block, in harmony with the http status code.
Status 200
{
"code": 2000,
"message": "success"
}
Take care, if http status code is 200 please avoid:
{
"code": 4040,
"message": "listing non found"
}
Because we will reach this answer as a success
.
Status 404
{
"code": 4040,
"message": "listing non found"
}
or
{
"code": 4400,
"message": "real estate agency non found"
}
The code
element into the JSON is different from the http
status code but it is in harmony with it.
Status 500
{
"code": 5000,
"message": "server error"
}
Response codes
Code | Response |
---|---|
2000 | Success |
4030 | Listing is not enabled |
4040 | Listing not found |
4300 | Real Estate Agency is not enabled |
4400 | Real Estate Agency not found |
45xx | Other logical errors |
5000 | Generic system error |
51xx | Other system error |
2025 Indomio.com