---
title: Publisher Products API
description: The Publisher Product API section allows you to view the API documentation for the Product.
---

[Skip to content](https://support.phonexa.com/publisher-products-api#main-content)

[![phonexa\_logo-white](https://support.phonexa.com/hubfs/phonexa_logo-white.svg)](https://support.phonexa.com/?hsLang=en)

Open main navigation

Close main navigation

- [➜\]](https://phonexa.com/)

[➜\]](https://phonexa.com/?hsLang=en)

 Phonexa Support Center

- There are no suggestions because the search field is empty.

1. [Knowledge Base](https://support.phonexa.com/?hsLang=en)
2. [LMS Sync & Call Logic](https://support.phonexa.com/lms-sync-call-logic?hsLang=en)
3. [Publisher management](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#publisher-management)

# Publisher Products API

## The Publisher Product API section allows you to view the API documentation for the Product.

To view the API documentation, go to the **Publisher Management \> Setup \> Publisher Products API** section.

[![](https://support.phonexa.com/hs-fs/hubfs/Publisher%20Products%20API%201.png?width=670&height=145&name=Publisher%20Products%20API%201.png)](https://support.phonexa.com/hubfs/Publisher%20Products%20API%201.png?hsLang=en)<https://phonexa-4703e840ef03.intercom-attachments-7.com/i/o/670134445/27e086060158b9eb6e74fbbd/2D4wCDZKIonpVWc0tEaxAUREqg5xjMfHKMkNFm3SLd0YYLxM5MInmWAOZZJPPne-2PZ2HHUWJL_oDl5HiyqeMkG48wSxTIDO5Fw3N8-slqYJ0nV9l4LeWH2H4NjZK_j9Zy_-L51n6IjaWL8LAHnrCg>

Select the Product from the list and click the **“Select”** button. The system will show the API documentation for the selected Product.

You can group the list of Products by selecting the lead posting type in the **“Posting Type”** field. 

[![](https://support.phonexa.com/hs-fs/hubfs/Publisher%20Products%20API%202.png?width=670&height=326&name=Publisher%20Products%20API%202.png)](https://support.phonexa.com/hubfs/Publisher%20Products%20API%202.png?hsLang=en)<https://phonexa-4703e840ef03.intercom-attachments-7.com/i/o/670134458/d356119f93468dd3e720250b/HkhSAnPtFThK9No6v5v0uUu-Woa509_E9Qrae6FN6peLWoUlg9cq_aKZEHLI2kqeLQu-Xf7Hw5WtRwnK1V_0lDz6XX77nNrGjI3uhlBQ9fNA-4fUCyXG5boKmlb4SJfvgXYzhmX-ehmCkRuaWrTCUA>

The document contains the following information:

- **[Introduction](https://support.phonexa.com/publisher-products-api#intro)**
- <https://support.phonexa.com/publisher-products-api#intro>**[Overview](https://support.phonexa.com/publisher-products-api#overview)**
- <https://support.phonexa.com/publisher-products-api#overview>**[Leads Specs](https://support.phonexa.com/publisher-products-api#lead-specs)**
- <https://support.phonexa.com/publisher-products-api#lead-specs>**[Code Samples](https://support.phonexa.com/publisher-products-api#code-samples)**
- <https://support.phonexa.com/publisher-products-api#code-samples>**[Response Samples](https://support.phonexa.com/publisher-products-api#response-samples)**
- <https://support.phonexa.com/publisher-products-api#response-samples>**[The Intermittent Lead Status Query](https://support.phonexa.com/publisher-products-api#lead-status-query)**
- [**Sample Code**](https://support.phonexa.com/publisher-products-api#CodeSamples)
- <https://support.phonexa.com/publisher-products-api#lead-status-query>[**Response Examples**](https://support.phonexa.com/publisher-products-api#response_examples)
- **[Test Mode](https://support.phonexa.com/publisher-products-api#test-mode)**

To download the documentation in PDF format, click the **“Print to PDF”** button.

### Introduction

In the **Introduction** block, you can view the introductory information about the API.

To change the introduction text according to your needs, click the **“Edit”** sign.

[![](https://support.phonexa.com/hs-fs/hubfs/Publisher%20Products%20API%203.png?width=670&height=72&name=Publisher%20Products%20API%203.png)](https://support.phonexa.com/hubfs/Publisher%20Products%20API%203.png?hsLang=en)

### Overview

The **Overview** block contains the following information:

- **Method:** Phonexa accepts leads through the HTTP POST process. Lead generators are asked to send leads via HTTP POST to the URL specified in the Leads Specs section.
- **Format/Data Type:** JSON or FORM.
- **Fields:** Phonexa API contains both required and optional fields. Phonexa will not accept a lead when any of the required fields are omitted, or the value of those fields is null or blank.
- **Testing:** To enable the test mode, add the testMode=1 parameter in the request. You can use the live credentials for testing.

To change the information in the Overview block according to your needs, click the **“Edit”** sign.

[![](https://support.phonexa.com/hs-fs/hubfs/Publisher%20Products%20API%204.png?width=670&height=143&name=Publisher%20Products%20API%204.png)](https://support.phonexa.com/hubfs/Publisher%20Products%20API%204.png?hsLang=en)

### Lead Specs

In the **Lead Specs** block, you can view the lead posting specifications. The information is separated into the following columns:

- **Field Name:** The name of the field.
- **Required** (YES/NO): Shows if the field is required.
- **Description:** The description of the information in the field.
- **Format:** Displays the data format that should be used in the field.
- **Example:** The data examples.

[![](https://support.phonexa.com/hs-fs/hubfs/Publisher%20Products%20API%205.png?width=670&height=323&name=Publisher%20Products%20API%205.png)](https://support.phonexa.com/hubfs/Publisher%20Products%20API%205.png?hsLang=en)

### Code Samples

In the **Code Samples** block, you can view examples of requests in different programming languages:

- **PHP FORM;**
- **Python FORM;**
- **Java FORM;**
- **Bash FORM;**
- **PHP JSON;**
- **Python JSON;**
- **Java JSON;**
- **Bash JSON.**

[![](https://support.phonexa.com/hs-fs/hubfs/Publisher%20Products%20API%207.png?width=670&height=140&name=Publisher%20Products%20API%207.png)](https://support.phonexa.com/hubfs/Publisher%20Products%20API%207.png?hsLang=en)

 

### Response Samples

The **Response Samples** block contains the templates of responses for accepted or rejected leads. The information is separated into 3 blocks:

- **Sold Lead (Accepted Customer from Lead Generator):** The response samples for accepted leads (editable block).
- **Reject Lead (Rejected Customer from Lead Generator):** The response samples for rejected leads. You can not edit this block.
- **Error:** The response samples for leads with errors. You can not edit this block.

[![](https://support.phonexa.com/hs-fs/hubfs/Publisher%20Products%20API%208-1.png?width=670&height=402&name=Publisher%20Products%20API%208-1.png)](https://support.phonexa.com/hubfs/Publisher%20Products%20API%208-1.png?hsLang=en)

### The Intermittent Lead Status Query

In the** Intermittent Lead Status Query** block, you can view the description of the lead processing method that allows you to reduce the consumption of resources and increase stability.<https://phonexa-4703e840ef03.intercom-attachments-7.com/i/o/670134914/b5921406c307ab0798a09d6d/k7u0fq_eDNBJiNEgH8rNgrlka-6lGhkx_ax1oQVzpUFA16DjH6Gi8_tFEipnJ5jFurKSWJ-mZ42JUfHISZKXdJj2Xp9709t5xuCog0QiQGenn1yOLOI4bJKUgN-8XBqhjidyF_N0XSarXAv2vnQKKA>

[![](https://support.phonexa.com/hs-fs/hubfs/undefined-Apr-28-2026-10-41-55-5769-AM.png?width=1139&height=542&name=undefined-Apr-28-2026-10-41-55-5769-AM.png)](https://support.phonexa.com/hubfs/undefined-Apr-28-2026-10-41-55-5769-AM.png?hsLang=en)

### Sample Code

In the **Sample Code** block, you can view the post examples in different programming languages: 

- **PHP FORM**;
- **Python FORM**;
- **Java FORM**;
- **Bash FORM**;
- **PHP JSON**;
- **Python JSON**;
- **Java JSON**;
- **Bash JSON**.

![](https://support.phonexa.com/hs-fs/hubfs/undefined-Apr-28-2026-10-41-04-8801-AM.png?width=580&height=278&name=undefined-Apr-28-2026-10-41-04-8801-AM.png)

 

### Response Examples

The **Response Examples** block contains the response cases according to the lead status. The available statuses are:

- **Sold;**
- **Reject;**
- **In Progress;**
- **Authorization failed;**
- **Not Found.**

[![](https://support.phonexa.com/hs-fs/hubfs/Publisher%20Products%20API%2010.png?width=670&height=440&name=Publisher%20Products%20API%2010.png)](https://support.phonexa.com/hubfs/Publisher%20Products%20API%2010.png?hsLang=en)

### Test Mode

In the **Test Mode** block, you can view the brief instructions on how to send a test lead.

[![](https://support.phonexa.com/hs-fs/hubfs/Publisher%20Products%20API%2011.png?width=670&height=113&name=Publisher%20Products%20API%2011.png)](https://support.phonexa.com/hubfs/Publisher%20Products%20API%2011.png?hsLang=en)<https://phonexa-4703e840ef03.intercom-attachments-7.com/i/o/670134938/d47c7f6cab782d5d69e93bec/dXJZ551FUJ-bmyXlHFuTsYZoc-twFGNUe_m2oALJcApJ0R-aMKa9ooBWJ0EJoZqbfe3wVOaNHE1GT6KFX9uBbj864wUgWZztq5fAX7mIS2IVBeQ8FrZpGxd-NqBhGyAv8wlVPbjEXADCbp94OoNT0g>

- [General information](https://support.phonexa.com/general-information?hsLang=en#main-content)

    - [Account Settings](https://support.phonexa.com/general-information?hsLang=en#account-settings)
    - [Security Settings](https://support.phonexa.com/general-information?hsLang=en#security-settings)
    - [Users](https://support.phonexa.com/general-information?hsLang=en#users)
    - [System Customization](https://support.phonexa.com/general-information?hsLang=en#system-customization)
    - [Project Customization](https://support.phonexa.com/general-information?hsLang=en#project-customization)
    - [Product Customization](https://support.phonexa.com/general-information?hsLang=en#product-customization)
    - [System Management](https://support.phonexa.com/general-information?hsLang=en#system-management)
    - [Support](https://support.phonexa.com/general-information?hsLang=en#support)
- [LMS Sync & Call Logic](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#main-content)

    - [Extra Features](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#extra-features)
    - [Publisher Configuration](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#publisher-configuration)
    - [Client Management](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#client-management)
    - [System Logs](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#system-logs)
    - [Documents And References](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#documents-and-references)
    - [Reports and Analytics](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#reports-and-analytics)
    - [Publisher management](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#publisher-management)
    - [Call Logic Customization](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#call-logic-customization)
    - [Campaign Configuration](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#campaign-configuration)
    - [Feed CMS](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#feed-cms)
    - [Event Tracking](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#event-tracking)
    - [iClear](https://support.phonexa.com/lms-sync-call-logic?hsLang=en#iclear)
- [E-Delivery](https://support.phonexa.com/e-delivery?hsLang=en#main-content)

    - [List Management](https://support.phonexa.com/e-delivery?hsLang=en#list-management)
    - [Email Campaigns](https://support.phonexa.com/e-delivery?hsLang=en#email-campaigns)
    - [SMS Campaigns](https://support.phonexa.com/e-delivery?hsLang=en#sms-campaigns)
    - [Reports](https://support.phonexa.com/e-delivery?hsLang=en#reports)
    - [Suppression Management](https://support.phonexa.com/e-delivery?hsLang=en#suppression-management)
- [Books360](https://support.phonexa.com/books360?hsLang=en#main-content)

    - [Books 360 Integration](https://support.phonexa.com/books360?hsLang=en#books-360-integration)
    - [Vendor Management](https://support.phonexa.com/books360?hsLang=en#vendor-management)
    - [Account](https://support.phonexa.com/books360?hsLang=en#account)
    - [Customer Management](https://support.phonexa.com/books360?hsLang=en#customer-management)
- [Opt-Intel](https://support.phonexa.com/opt-intel?hsLang=en#main-content)

    - [List Management](https://support.phonexa.com/opt-intel?hsLang=en#list-management)
    - [All Reports](https://support.phonexa.com/opt-intel?hsLang=en#all-reports)
    - [Mailers](https://support.phonexa.com/opt-intel?hsLang=en#mailers)
    - [Campaigns](https://support.phonexa.com/opt-intel?hsLang=en#campaigns)
    - [System Management](https://support.phonexa.com/opt-intel?hsLang=en#system-management)
- [HitMetrix](https://support.phonexa.com/hitmetrix?hsLang=en#main-content)

    - [Analytics](https://support.phonexa.com/hitmetrix?hsLang=en#analytics)
    - [Heatmaps](https://support.phonexa.com/hitmetrix?hsLang=en#heatmaps)
    - [System Management](https://support.phonexa.com/hitmetrix?hsLang=en#system-management)
- [Lynx](https://support.phonexa.com/lynx?hsLang=en#main-content)

    - [Offers](https://support.phonexa.com/lynx?hsLang=en#offers)
    - [LYNX Reports](https://support.phonexa.com/lynx?hsLang=en#lynx-reports)
    - [Advertisers](https://support.phonexa.com/lynx?hsLang=en#advertisers)
    - [Affiliates](https://support.phonexa.com/lynx?hsLang=en#affiliates)
    - [Account Settings](https://support.phonexa.com/lynx?hsLang=en#account-settings)
- [Cloud PBX](https://support.phonexa.com/cloud-pbx?hsLang=en)

[![Phonexa\_logo\_color](https://support.phonexa.com/hubfs/Phonexa_logo_color.svg "Phonexa_logo_color")](https://phonexa.com/?hsLang=en)

Phonexa Knowledge Base

<https://www.facebook.com/phonexa/> <https://twitter.com/@phonexacalls> <https://linkedin.com/company/phonexa> <https://www.youtube.com/channel/UC4l-Pr8jkfqNTruWi6UlucQ/videos> <https://www.instagram.com/phonexa/>

Copyright © 2026, Phonexa