Listrak SenderCode API

openapi: 3.2.0
info:
  title: Listrak Sender Code API
  version: v1
  x-logo:
    url: /SMS/Resources/Images/Logo.png
  description: 'Operations tagged SenderCode across 2 of this provider''s published API definitions: listrak-sms-openapi.json, listrak-sms-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.listrak.com/sms
tags:
- name: SenderCode
  description: A Sender code resource is used to retrieve Sender Code information for a company.
paths:
  /v1/ShortCode:
    get:
      tags:
      - SenderCode
      summary: Get SMS Sender Codes
      description: Retrieve a collection of Sender Code objects for a Company.
      operationId: SenderCode_GetShortCodeCollection
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Collection_SenderCode'
              example:
                status: 200
                nextPageCursor: null
                data:
                - shortCodeId: 0
                  code: null
                  country: null
                  merchantName: null
                  emailListId: 0
                  emailListName: null
                  externalEventId: 0
                  externalEventName: null
                  phoneNumberSegmentationFieldGroupId: 0
                  phoneNumberSegmentationFieldGroupName: null
                  phoneNumberSegmentationFieldId: 0
                  phoneNumberSegmentationFieldName: null
                  acquisitionSourceSegmentationFieldGroupId: 0
                  acquisitionSourceSegmentationFieldGroupName: null
                  acquisitionSourceSegmentationFieldId: 0
                  acquisitionSourceSegmentationFieldName: null
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: 400
                error: ERROR_INVALID_PARAMETER
                message: An invalid value was supplied for {Parameter}.
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: 401
                error: ERROR_UNAUTHORIZED
                message: Authorization was denied for this request.
      security:
      - OAuth 2: []
      x-code-samples:
      - lang: C#
        source: 'var client = new HttpClient();


          client.BaseAddress = new Uri("/");

          client.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);


          var response = await client.GetAsync("v1/ShortCode");

          '
      - lang: PHP
        source: "$client = new \\GuzzleHttp\\Client([\n\t'base_uri' => '/'\n]);\n\n$res = $client->request('GET', 'v1/ShortCode',  [\n\t'headers' => ['Authorization' => 'Bearer ' . $accessToken]\n]);\n"
    servers:
    - url: https://api.listrak.com/sms
  /v1/ShortCode/{senderCodeId}:
    get:
      tags:
      - SenderCode
      summary: Get SMS Sender Code
      description: Retrieve a single SMS Sender Code by Sender Code Id.
      operationId: SenderCode_GetShortCodeResource
      parameters:
      - name: senderCodeId
        in: path
        description: Identifier used to specify the Sender Code.
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resource_SenderCode'
              example:
                status: 200
                data:
                  shortCodeId: 0
                  code: null
                  country: null
                  merchantName: null
                  emailListId: 0
                  emailListName: null
                  externalEventId: 0
                  externalEventName: null
                  phoneNumberSegmentationFieldGroupId: 0
                  phoneNumberSegmentationFieldGroupName: null
                  phoneNumberSegmentationFieldId: 0
                  phoneNumberSegmentationFieldName: null
                  acquisitionSourceSegmentationFieldGroupId: 0
                  acquisitionSourceSegmentationFieldGroupName: null
                  acquisitionSourceSegmentationFieldId: 0
                  acquisitionSourceSegmentationFieldName: null
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: 400
                error: ERROR_INVALID_PARAMETER
                message: An invalid value was supplied for {Parameter}.
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: 404
                error: ERROR_UNABLE_TO_LOCATE_RESOURCE
                message: Unable to locate a resource associated with the senderCodeId supplied.
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: 401
                error: ERROR_UNAUTHORIZED
                message: Authorization was denied for this request.
      security:
      - OAuth 2: []
      x-code-samples:
      - lang: C#
        source: 'var client = new HttpClient();


          client.BaseAddress = new Uri("/");

          client.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);


          var response = await client.GetAsync("v1/ShortCode/{senderCodeId}");

          '
      - lang: PHP
        source: "$client = new \\GuzzleHttp\\Client([\n\t'base_uri' => '/'\n]);\n\n$res = $client->request('GET', 'v1/ShortCode/{senderCodeId}',  [\n\t'headers' => ['Authorization' => 'Bearer ' . $accessToken]\n]);\n"
    servers:
    - url: https://api.listrak.com/sms
components:
  schemas:
    Collection_SenderCode:
      type: object
      properties:
        status:
          format: int32
          description: HTTP status code.
          type: integer
        data:
          description: Collection of return data from the given call.
          type: array
          items:
            $ref: '#/components/schemas/SenderCode'
    SenderCode:
      description: SMS Sender Code Resource.
      type: object
      properties:
        shortCodeId:
          format: int32
          description: 'Identifier used to locate sender code resource.

            Keeping it named ShortCodeId to not potentially break client integrations.

            If this parameter name changes, it will change the response bodies of the SenderCodeController routes, and will

            require adjustments by clients.'
          type: integer
        code:
          description: SMS Sender Code.
          type: string
        country:
          description: ISO 3166-1 Alpha-2 code of the country associated with sender code.
          type: string
        merchantName:
          description: Name of merchant associated with sender code.
          type: string
        emailListId:
          format: int32
          description: Identifier of email list associated with sender code.
          type: integer
        emailListName:
          description: Name of email list associated with sender code.
          type: string
        externalEventId:
          format: int32
          description: Identifier of external event associated with sender code.
          type: integer
        externalEventName:
          description: Name of external event associated with sender code.
          type: string
        phoneNumberSegmentationFieldGroupId:
          format: int32
          description: Email list attribute id to store a contact's phone number.
          type: integer
        phoneNumberSegmentationFieldGroupName:
          description: Email list attribute name to store a contact's phone number.
          type: string
        phoneNumberSegmentationFieldId:
          format: int32
          description: Email list attribute group id to store a contact's phone number.
          type: integer
        phoneNumberSegmentationFieldName:
          description: Email list attribute group name to store a contact's phone number.
          type: string
        acquisitionSourceSegmentationFieldGroupId:
          format: int32
          description: Email list attribute group id to store a contact's acquisition source.
          type: integer
        acquisitionSourceSegmentationFieldGroupName:
          description: Email list attribute group name to store a contact's acquisition source.
          type: string
        acquisitionSourceSegmentationFieldId:
          format: int32
          description: Email list attribute id to store a contact's acquisition source.
          type: integer
        acquisitionSourceSegmentationFieldName:
          description: Email list attribute name to store a contact's acquisition source.
          type: string
    Resource_SenderCode:
      type: object
      properties:
        status:
          format: int32
          description: HTTP status code.
          type: integer
        data:
          $ref: '#/components/schemas/SenderCode'
          description: Return data.
    Error:
      type: object
      properties:
        status:
          format: int32
          description: HTTP status code.
          type: integer
        error:
          description: Error code indicating what error has occured.
          type: string
        message:
          description: Message describing the status and the error that occurred.
          type: string
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.listrak.com/OAuth2/Token
          scopes: {}
x-refined-from:
- listrak-sms-openapi.json
- listrak-sms-openapi.yml
x-amazon-apigateway-security-policy: TLS_1_0
x-tagGroups:
- name: API Reference
  tags:
  - Events
  - EventConfigurations