---
title: "Lookup coverage for a resource"
method: POST
path: "/resources/1/coverage-lookup"
tags: ["platform", "resources", "resource-management"]
---

# Lookup coverage for a resource

`POST /resources/1/coverage-lookup`

## Request

- Base URL: `https://api.infobip.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.infobip.com/resources/1/coverage-lookup`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `https://api.infobip.com/auth/1/oauth2/token`
  - API key in header `Authorization`
  - API key in header `Authorization`
  - HTTP basic

Look up the coverage for a single resource by specifying the resource type, identifier (such as sender name or phone number), and associated country code.<br/>

## Request body

- 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553IbResourceCoverageKey
  - `resourceType` 'ALPHANUMERIC' | 'NUMBER' | 'RCS_RESOURCE' | 'VIBER_RESOURCE' | 'APPLE_RESOURCE' | 'OPEN_CHANNEL_RESOURCE' | 'KAKAO_RESOURCE' | 'FACEBOOK_RESOURCE', required: Resource type.

## Response `200`

OK

- union: Information about resource coverage.
  - object: Information about the sender coverage.
    - `senderName` string: Alphanumeric sender name.
    - `countryCode` string, required: Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).
    - `countryName` string: Country name.
    - `capabilities` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553IbResourceCapability[]
      - `channel` 'SMS' | 'MMS' | 'RCS' | 'VIBER_BM' | 'VIBER_BOT' | 'APPLE_MB' | 'OPEN_CHANNEL' | 'KAKAO_CHINGU' | 'KAKAO_ALIM' | 'KAKAO_SANGDAM' | 'FACEBOOK_POSTS' | 'MESSENGER': Indicates the channel supported by the resource.
      - `coverage` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553IbResourceCoverage: Information about the networks configured for the resource.
        - `outbound` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553NetworkView[]
          - `mccNnc` string: Norm net code uniquely identifying the specific mobile network operator.
          - `networkName` string: Network name.
        - `inbound` boolean: Indicates if inbound configuration exists.
    - `resourceType` 'ALPHANUMERIC' | 'NUMBER' | 'RCS_RESOURCE' | 'VIBER_RESOURCE' | 'APPLE_RESOURCE' | 'OPEN_CHANNEL_RESOURCE' | 'KAKAO_RESOURCE' | 'FACEBOOK_RESOURCE': Resource type.
  - object: Information about the number coverage.
    - `number` string: Phone number.
    - `numberKey` string: Number key.
    - `platform` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553PlatformDocs: Platform applicationId and entityId to apply to inbound messages that pair to this configuration. If not provided, or if set to default values (applicationId = default and entityId = null), values from the associated number/resource will be used.
      - `applicationId` string: Platform applicationId.
      - `entityId` string: Platform entityId.
    - `numberType` 'VIRTUAL_LONG_NUMBER' | 'SHORT_CODE' | 'SIM_HOSTING' | 'VIRTUAL_SIM_HOSTING' | 'VIRTUAL_LONG_NUMBER_CALL_TRIGGER' | 'SHORT_CODE_USSD' | 'WHATSAPP' | 'VIBER' | 'VIBER_VOICE' | 'FACEBOOK' | 'RCS' | 'TELEGRAM' | 'KAKAO_SANGDAM' | 'ZALO_ZMS' | 'OPEN_CHANNEL' | 'ZALO_FOLLOWER': The type of number.
    - `countryCode` string: Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).
    - `countryName` string: Country name.
    - `capabilities` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553IbResourceCapability[]
      - `channel` 'SMS' | 'MMS' | 'RCS' | 'VIBER_BM' | 'VIBER_BOT' | 'APPLE_MB' | 'OPEN_CHANNEL' | 'KAKAO_CHINGU' | 'KAKAO_ALIM' | 'KAKAO_SANGDAM' | 'FACEBOOK_POSTS' | 'MESSENGER': Indicates the channel supported by the resource.
      - `coverage` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553IbResourceCoverage: Information about the networks configured for the resource.
        - `outbound` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553NetworkView[]
          - `mccNnc` string: Norm net code uniquely identifying the specific mobile network operator.
          - `networkName` string: Network name.
        - `inbound` boolean: Indicates if inbound configuration exists.
    - `resourceType` 'ALPHANUMERIC' | 'NUMBER' | 'RCS_RESOURCE' | 'VIBER_RESOURCE' | 'APPLE_RESOURCE' | 'OPEN_CHANNEL_RESOURCE' | 'KAKAO_RESOURCE' | 'FACEBOOK_RESOURCE': Resource type.
  - object: Information about the sender coverage.
    - `senderName` string: Sender name.
    - `countryCode` string: Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).
    - `countryName` string: Country name.
    - `capabilities` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553IbResourceCapability[]
      - `channel` 'SMS' | 'MMS' | 'RCS' | 'VIBER_BM' | 'VIBER_BOT' | 'APPLE_MB' | 'OPEN_CHANNEL' | 'KAKAO_CHINGU' | 'KAKAO_ALIM' | 'KAKAO_SANGDAM' | 'FACEBOOK_POSTS' | 'MESSENGER': Indicates the channel supported by the resource.
      - `coverage` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553IbResourceCoverage: Information about the networks configured for the resource.
        - `outbound` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553NetworkView[]
          - `mccNnc` string: Norm net code uniquely identifying the specific mobile network operator.
          - `networkName` string: Network name.
        - `inbound` boolean: Indicates if inbound configuration exists.
    - `resourceType` 'ALPHANUMERIC' | 'NUMBER' | 'RCS_RESOURCE' | 'VIBER_RESOURCE' | 'APPLE_RESOURCE' | 'OPEN_CHANNEL_RESOURCE' | 'KAKAO_RESOURCE' | 'FACEBOOK_RESOURCE': Resource type.
  - object: Information about the sender coverage.
    - `resource` string: Resource name.
    - `shared` boolean: Indicates whether a resource is shared.
    - `originalResourceName` string: Original resource name.
    - `countryCode` string: Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).
    - `countryName` string: Country name.
    - `capabilities` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553IbResourceCapability[]
      - `channel` 'SMS' | 'MMS' | 'RCS' | 'VIBER_BM' | 'VIBER_BOT' | 'APPLE_MB' | 'OPEN_CHANNEL' | 'KAKAO_CHINGU' | 'KAKAO_ALIM' | 'KAKAO_SANGDAM' | 'FACEBOOK_POSTS' | 'MESSENGER': Indicates the channel supported by the resource.
      - `coverage` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553IbResourceCoverage: Information about the networks configured for the resource.
        - `outbound` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553NetworkView[]
          - `mccNnc` string: Norm net code uniquely identifying the specific mobile network operator.
          - `networkName` string: Network name.
        - `inbound` boolean: Indicates if inbound configuration exists.
    - `resourceType` 'ALPHANUMERIC' | 'NUMBER' | 'RCS_RESOURCE' | 'VIBER_RESOURCE' | 'APPLE_RESOURCE' | 'OPEN_CHANNEL_RESOURCE' | 'KAKAO_RESOURCE' | 'FACEBOOK_RESOURCE': Resource type.
  - object: Information about the sender coverage.
    - `resource` string: Resource name.
    - `displayName` string: Display name.
    - `countryCode` string: Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).
    - `countryName` string: Country name.
    - `capabilities` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553IbResourceCapability[]
      - `channel` 'SMS' | 'MMS' | 'RCS' | 'VIBER_BM' | 'VIBER_BOT' | 'APPLE_MB' | 'OPEN_CHANNEL' | 'KAKAO_CHINGU' | 'KAKAO_ALIM' | 'KAKAO_SANGDAM' | 'FACEBOOK_POSTS' | 'MESSENGER': Indicates the channel supported by the resource.
      - `coverage` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553IbResourceCoverage: Information about the networks configured for the resource.
        - `outbound` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553NetworkView[]
          - `mccNnc` string: Norm net code uniquely identifying the specific mobile network operator.
          - `networkName` string: Network name.
        - `inbound` boolean: Indicates if inbound configuration exists.
    - `resourceType` 'ALPHANUMERIC' | 'NUMBER' | 'RCS_RESOURCE' | 'VIBER_RESOURCE' | 'APPLE_RESOURCE' | 'OPEN_CHANNEL_RESOURCE' | 'KAKAO_RESOURCE' | 'FACEBOOK_RESOURCE': Resource type.
  - object: Information about the sender coverage.
    - `resource` string: Resource name.
    - `shared` boolean: Indicates whether a resource is shared.
    - `capabilities` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553IbResourceCapability[]
      - `channel` 'SMS' | 'MMS' | 'RCS' | 'VIBER_BM' | 'VIBER_BOT' | 'APPLE_MB' | 'OPEN_CHANNEL' | 'KAKAO_CHINGU' | 'KAKAO_ALIM' | 'KAKAO_SANGDAM' | 'FACEBOOK_POSTS' | 'MESSENGER': Indicates the channel supported by the resource.
      - `coverage` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553IbResourceCoverage: Information about the networks configured for the resource.
        - `outbound` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553NetworkView[]
          - `mccNnc` string: Norm net code uniquely identifying the specific mobile network operator.
          - `networkName` string: Network name.
        - `inbound` boolean: Indicates if inbound configuration exists.
    - `resourceType` 'ALPHANUMERIC' | 'NUMBER' | 'RCS_RESOURCE' | 'VIBER_RESOURCE' | 'APPLE_RESOURCE' | 'OPEN_CHANNEL_RESOURCE' | 'KAKAO_RESOURCE' | 'FACEBOOK_RESOURCE': Resource type.
  - object: Information about the sender coverage.
    - `resource` string: Resource name.
    - `displayName` string: Display name.
    - `countryCode` string: Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).
    - `countryName` string: Country name.
    - `capabilities` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553IbResourceCapability[]
      - `channel` 'SMS' | 'MMS' | 'RCS' | 'VIBER_BM' | 'VIBER_BOT' | 'APPLE_MB' | 'OPEN_CHANNEL' | 'KAKAO_CHINGU' | 'KAKAO_ALIM' | 'KAKAO_SANGDAM' | 'FACEBOOK_POSTS' | 'MESSENGER': Indicates the channel supported by the resource.
      - `coverage` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553IbResourceCoverage: Information about the networks configured for the resource.
        - `outbound` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553NetworkView[]
          - `mccNnc` string: Norm net code uniquely identifying the specific mobile network operator.
          - `networkName` string: Network name.
        - `inbound` boolean: Indicates if inbound configuration exists.
    - `resourceType` 'ALPHANUMERIC' | 'NUMBER' | 'RCS_RESOURCE' | 'VIBER_RESOURCE' | 'APPLE_RESOURCE' | 'OPEN_CHANNEL_RESOURCE' | 'KAKAO_RESOURCE' | 'FACEBOOK_RESOURCE': Resource type.
  - object: Information about the sender coverage.
    - `resource` string: Resource name.
    - `displayName` string: Display name.
    - `countryCode` string: Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).
    - `countryName` string: Country name.
    - `capabilities` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553IbResourceCapability[]
      - `channel` 'SMS' | 'MMS' | 'RCS' | 'VIBER_BM' | 'VIBER_BOT' | 'APPLE_MB' | 'OPEN_CHANNEL' | 'KAKAO_CHINGU' | 'KAKAO_ALIM' | 'KAKAO_SANGDAM' | 'FACEBOOK_POSTS' | 'MESSENGER': Indicates the channel supported by the resource.
      - `coverage` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553IbResourceCoverage: Information about the networks configured for the resource.
        - `outbound` 7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553NetworkView[]
          - `mccNnc` string: Norm net code uniquely identifying the specific mobile network operator.
          - `networkName` string: Network name.
        - `inbound` boolean: Indicates if inbound configuration exists.
    - `resourceType` 'ALPHANUMERIC' | 'NUMBER' | 'RCS_RESOURCE' | 'VIBER_RESOURCE' | 'APPLE_RESOURCE' | 'OPEN_CHANNEL_RESOURCE' | 'KAKAO_RESOURCE' | 'FACEBOOK_RESOURCE': Resource type.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/infobip/apis/infobip-openapi-specification.md) - [All operations](https://skmtc.dev/infobip/apis/infobip-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/infobip/apis/infobip-openapi-specification/revisions/9dcbbaf902de?raw)