> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get My Caller I Ds

> Get caller ids that the current principal might be interested in (phone numbers of related persons in sales and appointments created/owned/touched by ourselves or colleagues in our primary group

NsApiSlow threshold: 5000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-PocketAgent.json post /api/v1/Agents/Pocket/GetMyCallerIDs
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - PocketAgent
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Agents/Pocket/GetMyCallerIDs:
    post:
      tags:
        - Pocket_Agent
      summary: Get My Caller I Ds
      description: >-
        Get caller ids that the current principal might be interested in (phone
        numbers of related persons in sales and appointments
        created/owned/touched by ourselves or colleagues in our primary group


        NsApiSlow threshold: 5000 ms.
      operationId: v1PocketAgent_GetMyCallerIDs
      parameters:
        - name: $select
          in: query
          description: >-
            Optional comma separated list of properties to include in the
            result. Other fields are then nulled out to reduce payload size:
            "Name,department,category". Default = show all fields.
          required: false
          schema:
            type: string
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.GetMyCallerIDsRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.GetMyCallerIDsRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.GetMyCallerIDsRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.GetMyCallerIDsRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.GetMyCallerIDsRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.GetMyCallerIDsRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.PocketCarriers.GetMyCallerIDsRequest
        description: LastHash, MinDate, MaxDate
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.CallerIDCollection
            text/json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.CallerIDCollection
            application/xml:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.CallerIDCollection
            text/xml:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.CallerIDCollection
            application/json-patch+json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.CallerIDCollection
            application/merge-patch+json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.CallerIDCollection
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.PocketCarriers.GetMyCallerIDsRequest:
      description: >-
        GetMyCallerIDs: Get caller ids that the current principal might be
        interested in (phone numbers of related persons in sales and
        appointments created/owned/touched by ourselves or colleagues in our
        primary group
      type: object
      properties:
        LastHash:
          type: string
        MinDate:
          format: date-time
          type: string
        MaxDate:
          format: date-time
          type: string
    SuperOffice.CRM.Services.CallerIDCollection:
      description: "Collection of caller ids with their corresponding hash\r\n<para />\r\nCarrier object for CallerIDCollection.\r\nServices for the CallerIDCollection Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IPocketAgent\">Pocket Agent</see>."
      type: object
      properties:
        CallerIDHash:
          description: >-
            Hash of the caller ids, used for checking if the same set of caller
            ids was sent earlier
          type: string
        CallerIDs:
          description: Array of caller ids, sorted numerically on the phone number
          type: array
          items:
            $ref: '#/components/schemas/SuperOffice.CRM.Services.CallerID'
    SuperOffice.CRM.Services.CallerID:
      description: "Describes a caller ID for Mobile to lookup phone calls. Can be for a person, or for a company, in which case the personId field will be 0\r\n<para />\r\nCarrier object for CallerID.\r\nServices for the CallerID Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IPocketAgent\">Pocket Agent</see>."
      type: object
      properties:
        PhoneNumber:
          format: int64
          description: >-
            Phone number, as a long instead of a string, to avoid parsing all
            the phonenumbers in Mobile CRM
          type: integer
        DialInPrefix:
          format: int32
          description: >-
            Prefix for dialing into the country from outside (country code),
            empty if PhoneNumber already contains the country code
          type: integer
        PersonId:
          format: int32
          description: Primary key
          type: integer
        PersonName:
          description: Full name of the person
          type: string
        Mrmrs:
          description: e.g. Mrs   sex_title
          type: string
        ContactId:
          format: int32
          description: Primary key
          type: integer
        ContactName:
          description: Contact name
          type: string

````

## Related topics

- [SuperOffice.WebApi.Data.Pocket GetMyCallerIDsRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Pocket_GetMyCallerIDsRequest.md)
- [SuperOffice.WebApi.Agents.IPocketAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IPocketAgent.md)
- [SuperOffice.WebApi.Agents.PocketAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.PocketAgent.md)
- [Get Caller I Ds From Selection](/en/api/reference/restful/agent/pocket_agent/get-caller-i-ds-from-selection.md)
- [SuperOffice.WebApi.Data.Pocket GetCallerIDsFromSelectionRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Pocket_GetCallerIDsFromSelectionRequest.md)
- [SuperOffice.WebApi.Data.CallerIDCollection](/en/api/reference/webapi/SuperOffice.WebApi.Data.CallerIDCollection.md)
