传真“来自"和"callerId" RingCentral传真API中缺少参数 [英] Fax "from" and "callerId" parameters missing from RingCentral fax API

问题描述

我一直在尝试使用RingCentral API发送传真，但是无法指定From传真电话号码来发送传真.它仅使用公司传真号码发送传真.我找不到从号码使用传真的选项.我正在使用以下端点发送传真:

I've been trying to send fax using RingCentral API but there is no way to specify the From fax phone number to send the fax. It is only sending the fax using company fax number. I am not able to find the option to use fax from number. I am using the following end point for sending fax:

https://platform.ringcentral .com/restapi/v1.0/account/:accountId/extension/:extensionId/fax

推荐答案

在RingCentral系统中，From(或发送)传真号码是传真呼叫者ID值.您可以更新此扩展名，以使其与传真一起使用，但是该值在发送传真API本身中不可用.要基于每次发送更改此设置，可以在每个传真请求之前更新呼叫者ID值.

In the RingCentral system, the From (or sending) fax number is the fax caller ID value. You can update this for your extension to use with your faxes, but the value is not available in the send fax API itself. To change this on a per send basis, you can update the caller ID value before each fax request.

您可以使用两种方法来更新传真呼叫者ID:

You can update the Fax Caller ID using two approaches:

1. 通过API或
2. 使用在线帐户门户网站( https://service.ringcentral.com )如下所述.

1. via API or
2. using the Online Account Portal (https://service.ringcentral.com), both of which are described below.

下面都将对此进行描述.让我知道这是否适合您.

Both are described below. Let me know if this works for you.

1)更新传真呼叫者ID

要更新传真呼叫者ID，请呼叫PUT extension/caller-id端点并使用您要使用的号码的电话号码ID更新callerId以使用FaxNumber功能.您可以通过调用下一部分中显示的extension/phone-number来获得此列表.

To update the fax caller ID, call the PUT extension/caller-id endpoint and update the callerId for the FaxNumber feature using the phone number ID of the number you are interested in using. You can get a list of this by calling the extension/phone-number shown in the next section.

PUT /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-id
Authorization: Bearer {accessToken}
Content-Type: application/json

{
  "byFeature": [
    {
      "feature": "FaxNumber",
      "callerId": {
        "phoneInfo": {
          "id": 33333333
        }
      }
    }
  ]
}

有关更多信息，请参见API参考: https://developer.ringcentral.com/api-docs/latest/index.html#!#RefUpdateCallerId

See the API Reference for more: https://developer.ringcentral.com/api-docs/latest/index.html#!#RefUpdateCallerId

1.1)列出可用的呼叫方ID号码

要获取可使用的数字列表，请调用GET extension/phone-number端点:

To get a list a list of numbers you can use, call the GET extension/phone-number endpoint:

GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/phone-number
Authorization: Bearer {accessToken}

在JSON响应中，您将在records属性中具有电话号码列表.您可以使用的数字将具有以下属性值:

In your JSON response, you will have a list of phone numbers in the records property. Numbers that you can use will have the following property values:

• features属性将具有CallerId值
• type属性将设置为VoiceFax或FaxOnly

• features property will have the CallerId value
• type property will be set to VoiceFax or FaxOnly

以下是显示一个数字的JSON响应的摘录.您应该有更多的数字和一个paging对象.

The following is the excerpt of a JSON response showing one number. You should have more numbers and a paging object.

{
  "uri": "https://platform.devtest.ringcentral.com/restapi/v1.0/account/11111111/extension/22222222/phone-number?page=1&perPage=100",
  "records": [
    {
      "id": 33333333,
      "phoneNumber": "[phone]",
      "paymentType": "Local",
      "location": "Belmont, CA",
      "type": "VoiceFax",
      "usageType": "DirectNumber",
      "status": "Normal",
      "country": {
        "uri": "https://platform.devtest.ringcentral.com/restapi/v1.0/dictionary/country/1",
        "id": "1",
        "name": "United States"
      },
      "features": [
        "SmsSender",
        "CallerId",
        "MmsSender"
      ]
    }
  ]
}

有关更多信息，请参见API参考: https: //developer.ringcentral.com/api-docs/latest/index.html#!#RefUserPhoneNumbers.html

See the API Reference for more: https://developer.ringcentral.com/api-docs/latest/index.html#!#RefUserPhoneNumbers.html

1.2)读取传真呼叫者ID值

RingCentral支持多个呼叫者ID值.要读取扩展的值，请对extension/caller-id端点进行以下API调用:

RingCentral supports multiple caller ID values. To read the value for your extension make the following API call to the extension/caller-id endpoint:

GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-id
Authorization: Bearer {accessToken}

您将收到如下响应，其中在byFeature属性中带有一个呼叫者ID值数组.查找feature属性设置为FaxNumber的功能.我仅在下面显示FaxNumber功能调用者ID，但是该数组包含以下功能:CallFlip，FaxNumber，RingMe，RingOut，MobileApp，Alternate.

You will receive a response like the following with an array of caller ID values in the byFeature property. Look for the feature with the feature property set to FaxNumber. I only show the FaxNumber feature caller ID below, but the array includes the following features: CallFlip, FaxNumber, RingMe, RingOut, MobileApp, Alternate.

{
  "uri": "https://platform.devtest.ringcentral.com/restapi/v1.0/account/11111111/extension/22222222/caller-id",
  "byFeature": [
    {
      "feature": "FaxNumber",
      "callerId": {
        "type": "PhoneNumber",
        "phoneInfo": {
          "uri": "https://platform.devtest.ringcentral.com/restapi/v1.0/account/11111111/phone-number/33333333",
          "id": "33333333",
          "phoneNumber": "[phone]"
        }
      }
    }
  ]
}

有关更多信息，请参见API参考: https://developer.ringcentral.com/api-docs/latest/index.html#!#RefGetCallerId

See the API Reference for more: https://developer.ringcentral.com/api-docs/latest/index.html#!#RefGetCallerId

2)使用在线帐户门户

您还可以在在线帐户门户中的以下位置更改呼叫者ID值:

You can also change the Caller ID value in the Online Account Portal under:

Settings> Outbound Calls> Caller ID> By Feature> Fax Number

此知识库文章中提供了更多信息:

More is available in this Knowledgebase Article:

https://success.ringcentral.com/articles/RC_Knowledge_Article/3614

这篇关于传真“来自"和"callerId" RingCentral传真API中缺少参数的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！