118712
Display residential and company contact details from the most enriched directory in France.

118712 Directory API

Directory API allows partners to search 118712 subscribers and find specific information about them.
[BASE URL: /118712/directory/fr/v1, API VERSION: 1.0.0, HOST: https://api.orange.com]
    • implementation notes

      Returns the status

      response class (status 200)
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      The Authorization with a valid tokenheaderstring
      (required)
      Customer's authorization tokenheaderstring
      JSONP function namequerystring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      503http status
      defaultError
    • implementation notes

      Returns information about API version

      response class (status 200)
      parameters
      parameter value description parameter type data type
      (required)
      The Authorization with a valid token header string
      (required)
      Customer's authorization token header string
      JSONP function name query string
      response messages
      List of common error codes
      HTTP status code reason response model
      401 List of supported error codes:
      - 1407: Access denied
      - 1481: Invalid credentials
      - 1424: Invalid parameter value: _jsonp
      406 List of supported error codes:
      - 1431: Invalid header value: Accept
      - 1432: The asked encoding is not accepted
      default Common error list
    • implementation notes

      Unique field search.
      Returns a list of subscribers matching the query searched.
      HTTP headers in the response return:

      • X-Total-Count: total number of responses for the given query
      • X-Result-Count: number of responses in the body (can be lower than the asked limit, if number of results is below)

      response class (status 200)
      response headers
      header description type
      X-Total-Count Total number of available items integer
      X-Result-Count Total number of returned items integer
      parameters
      parameter value description parameter type data type
      (required)
      The Authorization with a valid token header string
      (required)
      Customer's authorization token header string
      (required)
      What we want to search for

      Examples:
      • restaurant-paris
      • restaurant-open-ditch-mougins
      • 0123456789
      • 01-23-45-67-89
      A dash can stand for a white space or a dash

      Special characters the user don’t have to encode:
      • $-_.!*() &@=~':,
      Special characters the user have to encode:
      • éèêëàâîïôöûüçÉÈÊËÀÂÎÔÖÛÜ"#%{}|^[]`
      All other special characters are forbidden
      path string
      JSONP function name query string
      desktop or  smartphone or  tablet or  tv
      With this parameter the client can specify the client device query string
      Maximum number of results expected in the response list

      Default value depends on API client settings
      query integer
      business or  person
      Filter on type of subscribers searched

      By default, No filtering
      query string
      Enable displaying sponsored subscribers (also known as MPL)

      > MPL displayed:
      - enableSponored=1

      Default value depends on API client settings
      query boolean
      Enables the search string to be analyzed and reworded into something more likely to be relevant

      > Reword Search activated:
      - "fleur grasse" will be reworded into "fleuriste grasse" before searching

      Default value depends on API client settings
      query boolean
      Circular spatial search

      The WGS84 coordinates (latitude, longitude) of the center of the circle

      > Example:
      - 48.395701,-4.486942

      Mandatory parameter if radius is set
      query string
      The radius of circle for circular spatial search, in meters

      Can be a sequence of numbers separated by commas

      > Example:
      - 500,1000,5000
      query string
      The minimal number of results in all radius area given query integer
      Rectangular spatial search

      The WGS84 coordinates (latitude, longitude) of the top-left (north-west) of the rectangle

      > Example:
      - 48.395701,-4.486942

      Mandatory parameter if locatioSE is set
      query string
      Rectangular spatial search

      The WGS84 coordinates (latitude, longitude) of the bottom-right (south-east) of the rectangle

      > Example:
      - 48.395701,-4.486942

      Mandatory parameter if locationNW is set
      query string
      Reference of the captcha id, this parameter is using only when we want to solve the captcha query string
      The value expected to solve the captcha, this parameter is using only when we want to solve the captcha query string
      response messages
      List of common error codes
      HTTP status code reason response model
      400 List of supported error codes:
      - 1408: Keyword value is too long
      - 1409: Invalid keyword
      - 1410-1412: Invalid space search
      - 1420: Invalid parameter value: limit
      - 1421: Invalid parameter value: subscriberType
      - 1422: Invalid parameter value: enableSponsored
      - 1423: Invalid parameter value: rewordSearch
      - 1424: Invalid parameter value: _jsonp
      - 1425: Invalid parameter value: location
      - 1426: Invalid parameter value: radius
      - 1427: Invalid parameter value: locationNW
      - 1428: Invalid parameter value: locationSE
      - 1429: Invalid parameter value: captchaId
      - 1430: Invalid parameter value: captchaInput
      - 1433: Invalid parameter value: radiusMinSubscribers
      - 1450: Invalid parameter value : device
      401 List of supported error codes:
      - 1407: Access denied
      - 1481: Invalid credentials
      406 List of supported error codes:
      - 1431: Invalid header value: Accept
      - 1432: The asked encoding is not accepted
      default Common error list
    • implementation notes

      Generate an audio code to call a subscriber who doesn't want to show his own phone number

      response class (status 200)
      parameters
      parameter value description parameter type data type
      (required)
      The Authorization with a valid token header string
      (required)
      Customer's authorization token header string
      (required)
      Field phoneRef from the response of the unique field search or of the subscriber informations path string
      JSONP function name query string
      desktop or  smartphone or  tablet or  tv
      With this parameter the client can specify the client device query string
      Reference of the captcha id, this parameter is using only when we want to solve the captcha query string
      The value expected to solve the captcha, this parameter is using only when we want to solve the captcha query string
      response messages
      List of common error codes
      HTTP status code reason response model
      400 List of supported error codes:
      - 1424: Invalid parameter value: _jsonp
      - 1429: Invalid parameter value: captchaId
      - 1430: Invalid parameter value: captchaInput
      - 1440: Invalid parameter value : secretphone_id
      - 1450: Invalid parameter value : device
      401 List of supported error codes:
      - 1407: Access denied
      - 1481: Invalid credentials
      406 List of supported error codes:
      - 1431: Invalid header value: Accept
      - 1432: The asked encoding is not accepted
      default Common error list
    • implementation notes

      More information about a subscriber

      response class (status 200)
      parameters
      parameter value description parameter type data type
      (required)
      The Authorization with a valid token header string
      (required)
      Customer's authorization token header string
      (required)
      Field subscriberRef from the response of the search request path string
      JSONP function name query string
      desktop or  smartphone or  tablet or  tv
      With this parameter the client can specify the client device query string
      Reference of the captcha id, this parameter is using only when we want to solve the captcha query string
      The value expected to solve the captcha, this parameter is using only when we want to solve the captcha query string
      response messages
      List of common error codes
      HTTP status code reason response model
      400 List of supported error codes:
      - 1424: Invalid parameter value: _jsonp
      - 1429: Invalid parameter value: captchaId
      - 1430: Invalid parameter value: captchaInput
      - 1450: Invalid parameter value : device
      401 List of supported error codes:
      - 1407: Access denied
      - 1481: Invalid credentials
      406 List of supported error codes:
      - 1431: Invalid header value: Accept
      - 1432: The asked encoding is not accepted
      default Common error list
    • HTTP status codereasonresponse model
      400List of supported error codes:
      - 20: Invalid URL parameter value
      - 21: Missing body
      - 22: Invalid body
      - 23: Missing body field
      - 24: Invalid body field
      - 25: Missing header
      - 26: Invalid header value
      - 27: Missing query-string parameter
      - 28: Invalid query-string parameter value
      {
        "code": 28,
        "message": "Invalid query-string parameter value",
        "description": "One or more query-string parameters contain invalid values."
      }
      401List of supported error codes:
      - 40: Missing credentials
      - 41: Invalid credentials
      - 42: Expired credentials
      {
        "code": 42,
        "message": "Expired credentials",
        "description": "The requested service needs credentials, and the ones provided were out-of-date."
      }
      403List of supported error codes:
      - 50: Access denied
      - 51: Forbidden requester
      - 52: Forbidden user
      - 53: Too many requests
      {
        "code": 53,
        "message": "Too many requests",
        "description": "The application has made too many calls and has exceeded the rate limit for this service."
      }
      404List of supported error codes:
      - 60: Resource not found
      {
        "code": 60,
        "message": "Resource not found",
        "description": "The requested URI or the requested resource does not exist."
      }
      405List of supported error codes:
      - 61: Method not allowed
      {
        "code": 61,
        "message": "Method not allowed",
        "description": "The URI does not support the requested method. The available methods should be set in the response header 'Allow'"
      }
      406List of supported error codes:
      - 62: Not acceptable
      {
        "code": 62,
        "message": "Not acceptable",
        "description": "The Accept incoming header does not match any available content-type."
      }
      408List of supported error codes:
      - 63: Request time-out
      {
        "code": 63,
        "message": "Request time-out",
        "description": "The server timed out waiting for the incoming request."
      }
      411List of supported error codes:
      - 64: Length required
      {
        "code": 64,
        "message": "Length required",
        "description": "The request did not specify a Content-Length header, which is required by the requested resource."
      }
      412List of supported error codes:
      - 65: Precondition failed
      {
        "code": 65,
        "message": "Precondition failed",
        "description": "One of the precondition request headers (aka. 'If-None-Match', 'If-Match', 'If-Modified-Since', and 'If-Unmodified-Since') failed to match."
      }
      413List of supported error codes:
      - 66: Request entity too large
      {
        "code": 66,
        "message": "Request entity too large",
        "description": "The body of a request (PATCH, POST and PUT methods) is larger than the server is willing or able to process."
      }
      414List of supported error codes:
      - 67: Request-URI too long
      {
        "code": 67,
        "message": "Request-URI too long",
        "description": "The URI provided was too long for the server to process."
      }
      415List of supported error codes:
      - 68: Unsupported Media Type
      {
        "code": 68,
        "message": "Unsupported Media Type",
        "description": "The format of the posted body is not supported by the endpoint."
      }
      500List of supported error codes:
      - 1: Internal error
      {
        "code": 1,
        "message": "internal error",
        "description": "Generic failure message, used if no more precise code can be provided."
      }
      503List of supported error codes:
      - 5: The service is temporarily unavailable
      - 6: Orange API is over capacity, retry later !
      {
        "code": 6,
        "message": "Orange API is over capacity, retry later !",
        "description": "The service faces too much requests and can not handle the call."
      }