Ping & Post API

Posting Instructions Fields Required Ping API Shared Leads Post Direct Post by ZIP List
Health Ins. Home Ins. Legal Auto Ins. Home Services Life ins. Finance / Debt.
Calls
Call Home services Call Auto Ins. Call Health Ins. Call Legal. Call Finance/Debt.

Ping & Post Instructions
for Call Routing Other

Please use the following instructions to use our Ping/Post or Direct Post system for Call Routing Other Vertical.
In order to get identified, you will need to send the following parameters:
Ping
Required 		Post
Required 		field Contents Example of value
YES YES partnerid Will be provided XYZ
YES YES key Will be provided 771f5924706521c73464341fc48afb05
YES YES numcategory 19001 - Call Routing Dental   
19001
YES YES subid Your sub Source 123
OPTION OPTION resptype 'XML' to receive an XML response.
'JSON' to receive an JSON response.
if empty, the response format will be by default. 		XML
YES price The payout for the lead in $.
 0.15
NO OPTION price_tag 1 to receive the Price inside the Post response.
if empty, the response format will be by default. (See response example)		 1
NO YES token Value you received in case of positive Ping.
Must be sent on the Post.		 e69412030cc93b47cf5be6f7e3ee998c
Fields Required for Call Routing Other
Ping
Required 		Post
Required 		fieldname Value - Label Example of value
YES YES transfer_type integer Set. Allowed values:
1 - Inbounds
2 - Transfers
1
YES YES zipcode varchar(5) 33139
NO OPTION state varchar(2) FL
NO OPTION firstname varchar(50) John
NO OPTION lastname varchar(50) Doe
NO OPTION address varchar(100) 1210 Ocean Drive
NO OPTION city varchar(100) Miami
NO OPTION telephone varchar(50) 8772681223
NO OPTION email varchar(50) john.doe@gmail.com
NO OPTION comments varchar(500) Free comment
NO OPTION customid varchar(50) 12345
PING API
Methods
You can call the PING API using three different methods:
  • cURL POST with URL-encoded data
  • cURL POST with JSON data
  • HTTP GET request

    Required Fields
    When making a PING request, the following fields are mandatory and must be included:
  • partnerid: Your unique partner ID.
  • key: Your API key for authentication.
  • numcategory: The category number for the service.
  • subid: Your unique sub ID.

    • In addition to the fields mentioned above, all fields marked as "Ping Required" with Yes in the "Fields Required" table above must also be included in the request.

    Response
    The API will respond in one of the following ways:
  • Accepted: We will return a price and a token that you can reuse in the POST API.
  • Rejected: The request will be rejected with a detailed reason provided in the response.
    TEST MODE
    Only For test Mode please :
  • use key = test_mode (The Live Mode Key will be provided upon completion of successful Test.)
  • use subid = match To simulate a positive response
    • For direct post according to a ziplist
  • add price = 0.5
    • #errorCode# Meaning
    1000 Server under maintenance
    1100 Request limit exceeded
    2000 Invalid Partner ID or Blocked source
    3000 Approval Phase
    4000 Daily Cap reached
    5000 No coverage or buyers
    6000 Minimum bid not met
    Other Ask Your Representative
    SHARED LEADS
    Request Parameters
    - Add the `shared` parameter: Include the parameter shared =1 to indicate that the lead being sent is a shared lead (non-exclusive).
    - Additional Parameters for Shared Leads:
  • nb_legs_available The number of legs (potential buyers) still available for this lead.
  • nb_legs_sold The number of legs (buyers) this lead has already been sold to.
  • hash_legs_sold A comma-separated list of SHA1-hashed phone numbers of the contractors to whom this lead has already been sold.
    • These parameters help the system manage shared leads efficiently by ensuring the lead is not resold to the same contractors.

    Responses
    Success for a Shared Lead:
    - If all parameters sent match the expected values, the system will respond with:
  • `ACCEPTED`: Confirmation that the shared lead is accepted.
  • `token`: A unique identifier for this lead submission.
  • `Price`: The price offered for the lead.
  • `nbLegs`: The number of legs (buyers) the system is interested in purchasing for this lead.
  • `hashes`: A comma-separated list of SHA1-hashed phone numbers of the potential contractors to whom the legs will be sold.


    • Failure
    - The response will mirror the failure response of an exclusive ping, indicating why the shared lead could not be accepted.
    POST API
    Required Fields
    When making a POST request, the following fields are mandatory and must be included:
  • partnerid: Your unique partner ID.
  • key: Your API key for authentication.
  • numcategory: The category number for the service.
  • subid: Your unique sub ID.
  • token: the token received on the Ping response.

    • In addition to the fields mentioned above, all fields marked as "Post Required" with Yes in the "Fields Required" table above must also be included in the request.

    Response
    The post API will respond in one of the following ways:
  • Accepted: see examples...
  • Rejected: if the leads is post rejected, .
    • DIRECT POST ACCORDING TO A ZIPLIST
    The Direct Post method allows you to submit leads in a single step, based on the Ziplist provided.
  • Your account must first be configured by an Affiliate Manager, we will define the price for each category and Ziplist based on the agreement.
  • Single-Step Process: Unlike the ping-post process, the Direct Post only requires a single submission (post). There is no need for a ping step.
  • Submit your leads to this endpoint https://home-services.api-exactcustomer.com/direct_post_partner.php
  • Pass the Post fields as in a standard API post. Exclude the token field and include the price field with the value based on the Ziplist provided by your representative.

    The response from the API is the same as in the standard Post process. You will receive a JSON or XML response indicating the status of the lead submission and any relevant details.

    • jerems16