機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

電話検証の作成

post

/crmRestApi/resources/11.13.18.05/phoneVerification

リクエスト

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

サポートされるメディア・タイプ

• application/json

リクエスト本文 - application/json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• CountryPrefix: string
  国際ダイヤル時に番号の前に付加する必要がある国プリフィクス。
• Id: integer
  検証APIの一意の識別子。
• IsValid: string
  数字が有効かどうかを示します。 検証が不可能な場合は不明を返します。
• NationalFormat: string
  同じ国内からのダイヤルに便利な国内ネットワーク形式。
• NetworkCode: string
  指定された数値を提供する現在の演算子。
• NetworkCountry: string
  オペレータの国コード。
• NetworkName: string
  指定された番号を提供する現在の演算子の名前。
• NumberType: string
  MOBILE、LANDLINE、VOIPなど、リクエストで検出された番号のタイプ。
• PhoneNumber: string
  国際形式での受信者の電話番号。
• PhoneVerificationEnabled: string
  検証サービスが有効かどうかを示します。
• RequestProcessed: string
  リクエスト・プロセス。 これは、ネットワーク上のリクエストが処理された場合はtrueを返し、検証が成功しなかった場合はfalseを返します。
• VerificationCode: string
  提供された電話番号の確認コード。
• VerificationHelpText: string
  返される検証ステータスのテキスト形式のヘルプの説明。
• VerificationStatus: string
  指定された電話番号の検証ステータス。
• VerificationText: string
  返される検証コードの説明。

{
    "type":"object",
    "properties":{
        "VerificationStatus":{
            "type":"string",
            "description":"The verification status of the phone number provided.",
            "nullable":true
        },
        "RequestProcessed":{
            "type":"string",
            "description":"The request process. This returns true if the request on the network is processed or false if the validation was unsuccessful.",
            "nullable":true
        },
        "NetworkName":{
            "type":"string",
            "description":"The name of the current operator serving the supplied number.",
            "nullable":true
        },
        "VerificationCode":{
            "type":"string",
            "description":"The verification code of the phone number provided.",
            "nullable":true
        },
        "NetworkCode":{
            "type":"string",
            "description":"The current operator serving the supplied number.",
            "nullable":true
        },
        "CountryPrefix":{
            "type":"string",
            "description":"The country prefix that must be prepended to the number when dialing internationally.",
            "nullable":true
        },
        "PhoneVerificationEnabled":{
            "type":"string",
            "description":"Indicates whether the verification service is enabled.",
            "nullable":true
        },
        "NumberType":{
            "type":"string",
            "description":"The type of number that was detected in the request such as MOBILE, LANDLINE, or VOIP.",
            "nullable":true
        },
        "NationalFormat":{
            "type":"string",
            "description":"The domestic network format which is useful for dialing from within the same country.",
            "nullable":true
        },
        "PhoneNumber":{
            "type":"string",
            "description":"The recipient phone number in international format.",
            "nullable":true
        },
        "NetworkCountry":{
            "type":"string",
            "description":"The country code of the operator.",
            "nullable":true
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier for the verification API.",
            "nullable":true
        },
        "VerificationText":{
            "type":"string",
            "description":"A description of the verification code returned.",
            "nullable":true
        },
        "VerificationHelpText":{
            "type":"string",
            "description":"A textual help description of the verification status returned.",
            "nullable":true
        },
        "IsValid":{
            "type":"string",
            "description":"Indicates whether the number is valid or not. This returns Unknown if validation was not possible.",
            "nullable":true
        }
    }
}

トップに戻る

応答

サポートされるメディア・タイプ

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

• Metadata-Context(required):
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : phoneVerification-item-response

タイプ: object

ソースを表示

• CountryPrefix: string
  国際ダイヤル時に番号の前に付加する必要がある国プリフィクス。
• Id: integer
  検証APIの一意の識別子。
• IsValid: string
  数字が有効かどうかを示します。 検証が不可能な場合は不明を返します。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• NationalFormat: string
  同じ国内からのダイヤルに便利な国内ネットワーク形式。
• NetworkCode: string
  指定された数値を提供する現在の演算子。
• NetworkCountry: string
  オペレータの国コード。
• NetworkName: string
  指定された番号を提供する現在の演算子の名前。
• NumberType: string
  MOBILE、LANDLINE、VOIPなど、リクエストで検出された番号のタイプ。
• PhoneNumber: string
  国際形式での受信者の電話番号。
• PhoneVerificationEnabled: string
  検証サービスが有効かどうかを示します。
• RequestProcessed: string
  リクエスト・プロセス。 これは、ネットワーク上のリクエストが処理された場合はtrueを返し、検証が成功しなかった場合はfalseを返します。
• VerificationCode: string
  提供された電話番号の確認コード。
• VerificationHelpText: string
  返される検証ステータスのテキスト形式のヘルプの説明。
• VerificationStatus: string
  指定された電話番号の検証ステータス。
• VerificationText: string
  返される検証コードの説明。

{
    "type":"object",
    "properties":{
        "VerificationStatus":{
            "type":"string",
            "description":"The verification status of the phone number provided.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestProcessed":{
            "type":"string",
            "description":"The request process. This returns true if the request on the network is processed or false if the validation was unsuccessful.",
            "nullable":true,
            "x-queryable":true
        },
        "NetworkName":{
            "type":"string",
            "description":"The name of the current operator serving the supplied number.",
            "nullable":true,
            "x-queryable":true
        },
        "VerificationCode":{
            "type":"string",
            "description":"The verification code of the phone number provided.",
            "nullable":true,
            "x-queryable":true
        },
        "NetworkCode":{
            "type":"string",
            "description":"The current operator serving the supplied number.",
            "nullable":true,
            "x-queryable":true
        },
        "CountryPrefix":{
            "type":"string",
            "description":"The country prefix that must be prepended to the number when dialing internationally.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneVerificationEnabled":{
            "type":"string",
            "description":"Indicates whether the verification service is enabled.",
            "nullable":true,
            "x-queryable":true
        },
        "NumberType":{
            "type":"string",
            "description":"The type of number that was detected in the request such as MOBILE, LANDLINE, or VOIP.",
            "nullable":true,
            "x-queryable":true
        },
        "NationalFormat":{
            "type":"string",
            "description":"The domestic network format which is useful for dialing from within the same country.",
            "nullable":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "type":"string",
            "description":"The recipient phone number in international format.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NetworkCountry":{
            "type":"string",
            "description":"The country code of the operator.",
            "nullable":true,
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier for the verification API.",
            "nullable":true,
            "x-queryable":true
        },
        "VerificationText":{
            "type":"string",
            "description":"A description of the verification code returned.",
            "nullable":true,
            "x-queryable":true
        },
        "VerificationHelpText":{
            "type":"string",
            "description":"A textual help description of the verification status returned.",
            "nullable":true,
            "x-queryable":true
        },
        "IsValid":{
            "type":"string",
            "description":"Indicates whether the number is valid or not. This returns Unknown if validation was not possible.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

• href: string
  タイトル: hyperlink reference

  関連リソースへのURI。
• kind: string
  タイトル: kind

  許可された値: [ "collection", "item", "describe", "other" ]

  関連リソースの種類。
• name: string
  タイトル: name

  関連リソースへのリンクの名前。
• properties: object properties
• rel: string
  タイトル: relation

  許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  リソース・インスタンスとの関係の名前。 例: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

「トップに戻る」