TalkPush Messaging API API

openapi: 3.0.0
info:
  description: '<b>Production Base URL to be used during implementation:</b> {your company workspace subdomain}.talkpush.com/api/talkpush_services


    With the Talkpush APIs you can instantly plug your lead source into out platform to enjoy the benefits of Talkpush. You can also synch your <b> existing HR / Recruitment technology stack </b> with your Talkpush account. To be able to use our API you will need pass an api key as a parameter for each API call.  In case you do not know your current API key you can contact our support team at cs@talkpush.com.

    '
  version: '2.0'
  title: Talkpush Agents API Messaging API API
  contact:
    email: admin@talkpush.com
servers:
- url: https://company_subdomain.talkpush.com/api/talkpush_services
tags:
- name: Messaging API
  description: Collection of endpoints related to sending messages
paths:
  /messaging/quick_replies:
    get:
      tags:
      - Messaging API
      summary: Retrieve all the available Quick Reply templates
      description: This endpoint let's you retrieve all the available Quick Reply templates, view their content, title and the ID which you will require in order to send a message via the /messaging endpoint.
      parameters:
      - name: api_key
        in: query
        description: The API key provided for your application
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Quick Replies were returned successfully
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/quick_reply_response'
        '404':
          description: Quick Replies not found for this company
        '500':
          description: Internal server error, we will provide you with the exception message of the application.
  /messaging/messages:
    post:
      tags:
      - Messaging API
      summary: Send a quick reply template to a lead.
      description: 'This endpoint lets you send a quick reply template to a given lead, via a determined channel. The ID of a quick reply template can be retrieved either inside the CRM''s Quick Reply Management Screen or via the /messaging/quick_replies endpoint specified below.

        '
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/message_body_request'
        description: The body of the request.
        required: true
      responses:
        '200':
          description: Message is being sent.
        '400':
          description: Bad request. Please make sure that no invalid parameters were provided.
        '404':
          description: Campaign Invitation not found | Quick Reply not found.
        '500':
          description: Internal server error, we will provide you with the exception message of the application.
components:
  schemas:
    quick_reply:
      type: object
      properties:
        id:
          type: integer
          description: The ID of the quick reply, to be used in the messaging API.
        title:
          type: string
          description: The title of the quick reply, this serves to find Quick Replies inside the CRM, but is not part of the message sent to the candidate.
        content:
          type: string
          description: The content of the body is the actual message that is sent to the candidate, it may contain Tokens (e.g. Candidate Name) that are dynamically replaced by CRM upon sending the message.
    message_body:
      type: object
      required:
      - campaign_invitation_id
      - channel
      - quick_reply_id
      properties:
        campaign_invitation_id:
          type: integer
          description: The ID of the lead
        channel:
          type: string
          description: The channel via which the message should be sent. Available values - "Messenger", "SMS", "Email", "Whatsapp", "LastChannel". Using the LastChannel option will send the message via the last channel on which this lead was contacted. This channel option is useful if you want to make sure that the candidate receives the message irregardless of the channel.
        quick_reply_id:
          type: integer
          description: The ID of the quick reply template that should be sent.
    quick_reply_response:
      type: object
      properties:
        quick_replies:
          type: array
          items:
            $ref: '#/components/schemas/quick_reply'
    message_body_request:
      type: object
      required:
      - api_key
      - message
      properties:
        api_key:
          type: string
          description: The API key provided for your application
        message:
          $ref: '#/components/schemas/message_body'