PHONE APPLI API (1.14)

はじめに

PHONE APPLI API は外部アプリケーションから PHONE APPLI PEOPLE（以下：PA PEOPLE）のデータ入出力などを行うことができるプログラミングインターフェイスです。DX 推進や業務改革にぜひご活用ください。

利用規約

本 API を利用することにより、API 利用規約に同意したものとします。ご利用の前に必ずお読みください。

API キーの発行方法

PHONE APPLI API のご利用には API キーが必要です。
PC ブラウザ版 PA PEOPLE のメニュー［ユーザ情報］を開き、［APIキー］タブから発行、取得できます。
必要な権限範囲は各 API の AUTHORIZATIONS をご確認ください。
※ PHONE APPLI API が有効化されていない環境では、API キー発行画面は表示されません。

制限事項

レート制限

トークンバケットアルゴリズムを用いて API キーごとのリクエスト数に上限を設けています。
現在のリクエスト制限の詳細はレスポンスヘッダから確認することができます。
システムの負荷状況に応じて、リクエスト数の上限が変動する可能性があります。
リクエスト上限超過時のエラーついてはエラーレスポンスを参照してください。　　
一部 API では、こちらのレート制限とは別にテナントごとのリクエスト数に上限を設けています。

レスポンスヘッダ

レスポンスヘッダ内には以下が含まれます。

ヘッダ名	説明
x-ratelimit-remaining	トークン残量
x-ratelimit-requested-tokens	リクエストの処理に使用したトークンの個数
x-ratelimit-burst-capacity	バケットが保持できるトークンの個数
x-ratelimit-replenish-rate	1秒間に補充されるトークンの個数

利用権限

API キー発行元のユーザが持つ閲覧・編集の権限範囲内で利用できます。

キーの発行数制限

1ユーザあたり同時に10個まで発行できます。

エラーレスポンス

エラー発生時には以下表の HTTP ステータスコードとステータスを返します。ステータスは JSON 形式のエラーオブジェクトに含まれます。例外として、HTML 形式のエラーページを返す場合があります。

コード	ステータス	説明
400	INVALID_ARGUMENT	リクエストの構文が正しくない場合
401	UNAUTHENTICATED	認証情報が不足している場合
403	RESOURCE_PERMISSION_DENIED	対象リソースが権限範囲外である場合
403	API_PERMISSION_DENIED	対象APIが権限範囲外である場合
403	ACCESS_DENIED	IPアドレスが制限されている場合
404	NOT_FOUND	対象リソースが存在しない場合
405	METHOD_NOT_ALLOWED	リクエストメソッドが受け入れられない場合
406	NOT_ACCEPTABLE	指定されたデータ形式で応答できない場合
409	CONFLICT	リクエストがサーバーの状態と競合している場合
409	ALREADY_EXISTS	既存のリソースと重複する場合
413	PAYLOAD_TOO_LARGE	リクエストされたデータサイズが上限を超えている場合
415	UNSUPPORTED_MEDIA_TYPE	データ形式が受け入れられない場合
422	UNPROCESSABLE	リクエストの構文は正しいが、指示が実行できない場合
429	-	リクエスト回数が上限を超えている場合
500	INTERNAL_SERVER_ERROR	内部エラーが発生している場合
503	SERVICE_UNAVAILABLE	サーバーがダウンしている場合

社内連絡先

PA PEOPLE の社内電話帳の連絡先（ユーザ）です。

ユーザタイプによる制限

一部の項目はユーザタイプによって作成/編集に制限があります。下記の表に○の記載がある項目のみ登録、変更が可能です。

対象項目	基本利用ユーザ	登録限定ユーザ
enabled	○
forceLocalAuthentication	○
deviceId	○
deviceIdAcceptInitialize	○
password	○
initialPasswordForceChange	○
employeeNum	○	○
position	○	○
positionAlphabet	○	○
post	○	○
skill	○	○
pbxPartition	○
companyMobileNum	○	○
personalMobileNum	○	○
mobileNum	○	○
webUrl	○	○
chatSettingList	○	○
m365Account	○	○
pbxAccount	○
spCallSettings	○
roles	○
paapiAvailable	○
tenantCucmAdapterSettingsId	○
ctiPort	○
tenantAvayaAdapterSettingsId	○
gotalkAvailable	○
gotalkLogDownloadAvailable	○
anpiLoginId	○	○
mobileMacAddress	○	○
thanksAvailable	○

社内連絡先一覧取得

社内電話帳に登録された連絡先（ユーザ）の情報を一覧で取得できます。権限範囲の項目のみ取得可能です。

Authorizations:

ApiKeyAuth

query Parameters

page	integer <int32> >= 0 Default: 0 取得対象ページの番号
pageSize	integer <int32> [ 1 .. 100 ] Default: 30 1ページあたりの件数
select	Array of strings Items Enum: "userId" "loginId" "employeeNum" "divisions" "position" "positionAlphabet" "post" "fullname" "fullnameKana" "fullnameAlphabet" "extensionNum" "phoneNum" "companyMobileNum" "personalMobileNum" "mobileNum" "faxNum" "email1" "email2" "sortScore" "collaborations" "comment" "remarks" "skill" "initialPasswordForceChange" "userType" "roles" "paapiAvailable" "enabled" "forceRequestOperator" "gotalkAvailable" "gotalkLogDownloadAvailable" "forceLocalAuthentication" "pbxFeatureAvailable" "thanksAvailable" "pbxPartition" "webUrl" "level" "pcMacAddress" "mobileMacAddress" "bleId" "deviceIdAcceptInitialize" "deviceId" "m365Account" "pbxAccount" "iosPasyncLabel" "ctiPort" "incomingPopupIosApns" "tenantCucmAdapterSettings" "tenantAvayaAdapterSettings" "anpiLoginId" "spCallSettings" "contactDetailsUrl" 取得対象項目 ※ 権限範囲の項目のみ指定可能
orderBy	string Default: "fullname" Enum: "fullname" "sortScore" "employeeNum" ソートの対象 fullname: 氏名カナ順 sortScore: ソートスコア順 employeeNum: 社員番号順
orderDirection	string Default: "asc" Enum: "asc" "desc" ソートの並び順 asc: 昇順 desc: 降順
userType	string Enum: "REGULAR_USER" "REGISTRATION_ONLY_USER" "FACILITY" 取得対象のユーザタイプ REGULAR_USER: 基本利用ユーザ REGISTRATION_ONLY_USER: 登録限定ユーザ FACILITY: 施設・備品
fullname	string <= 50 characters 取得対象の氏名（部分一致）
fullnameKana	string <= 50 characters 取得対象の氏名カナ（部分一致）
divisionIds	Array of integers <int64> <= 50 items [ items <int64 > ] 取得対象の部署識別番号
includeSubDepartment	boolean Default: false 配下の部署を含む
userIds	Array of integers <int64> <= 50 items [ items <int64 > ] 取得対象のユーザ識別番号
loginIds	Array of strings <= 50 items 取得対象のログインID（完全一致）
employeeNum	string <= 50 characters 取得対象の社員番号（完全一致）
phoneNum	string <= 50 characters [0-9#,;+-] 取得対象の電話番号 ※ PA PEOPLEでは、電話番号は「+」（先頭以外）と「-」を含まない書式で登録されている（例：APIで「+81-3-1234-5678」を指定した場合、「+81312345678」と登録されている連絡先を取得できる） ※ 部分一致検索不可
email1	string <= 256 characters 取得対象のEメールアドレス1（完全一致）
freeWords	Array of strings フリーワード検索 ※ カンマ区切りで AND 検索

Responses

Response samples

200
default

Content type

application/json

{"hasMore": true,
"items": [{"userId": 0,
"userType": "REGULAR_USER",
"enabled": true,
"forceLocalAuthentication": true,
"deviceId": "string",
"deviceIdAcceptInitialize": true,
"loginId": "string",
"initialPasswordForceChange": true,
"sortScore": 0,
"level": 0,
"fullname": "string",
"fullnameKana": "string",
"fullnameAlphabet": "string",
"employeeNum": "string",
"position": "string",
"positionAlphabet": "string",
"post": "string",
"divisions": [{"divisionId": 0,
"divisionName": "string"
}
],
"comment": "string",
"remarks": "string",
"skill": "string",
"pbxPartition": "string",
"extensionNum": "string",
"companyMobileNum": "string",
"personalMobileNum": "string",
"phoneNum": "string",
"mobileNum": "string",
"faxNum": "string",
"email1": "string",
"email2": "string",
"webUrl": "string",
"collaborations": [{"chatSettingSeq": 0,
"clientName": "string",
"chatAccountId": "string"
}
],
"m365Account": "string",
"pbxAccount": "string",
"iosPasyncLabel": "string",
"spCallSettings": ["DIRECT_CALL"
],
"roles": ["ADMIN_COMPANY"
],
"paapiAvailable": true,
"forceRequestOperator": "DISABLE",
"pbxFeatureAvailable": true,
"tenantCucmAdapterSettings": {"tenantCucmAdapterSettingsId": 0,
"cucmAdapterName": "string"
},
"ctiPort": "string",
"incomingPopupIosApns": true,
"tenantAvayaAdapterSettings": {"tenantAvayaAdapterSettingsId": 0,
"avayaAdapterName": "string"
},
"gotalkAvailable": true,
"gotalkLogDownloadAvailable": true,
"anpiLoginId": "string",
"mobileMacAddress": "string",
"pcMacAddress": "string",
"bleId": "string",
"thanksAvailable": true,
"contactDetailsUrl": "string"
}
]
}

社内連絡先作成

社内連絡先（ユーザ）を作成できます。
※ ご利用にはユーザ管理権限が必要です。

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

userType	string Enum: "REGULAR_USER" "REGISTRATION_ONLY_USER" "FACILITY" ユーザタイプ REGULAR_USER: 基本利用ユーザ REGISTRATION_ONLY_USER: 登録限定ユーザ FACILITY: 施設・備品
enabled	boolean アカウント有効/無効
forceLocalAuthentication	boolean SAML認証または OpenID Connect 利用環境でローカル認証のみに制限
deviceId	string <= 8 characters ^$\|^[0-9a-zA-Z]+$ 端末ID
deviceIdAcceptInitialize	boolean 端末ID 初回認証
loginId required	string <= 50 characters ^[@a-zA-Z0-9.!#$%&'*+/=?^_`{\|}~-]+$ ログインID
password	string <= 50 characters ^(?!(\s\|　)*$).+ パスワード ※ 基本利用ユーザの場合は必須 ※ 基本利用ユーザ以外の場合は指定不要
initialPasswordForceChange	boolean Default: false 初期パスワード変更
sortScore	integer <int32> [ 0 .. 999999999 ] ソートスコア
level	integer <int32> [ 1 .. 10 ] Default: 5 レベル
fullname required	string <= 50 characters ^(?!(\s\|　)*$).+ 氏名
fullnameKana	string <= 50 characters 氏名カナ
fullnameAlphabet	string <= 50 characters 氏名英字
employeeNum	string <= 50 characters 社員番号
position	string <= 100 characters 役職
positionAlphabet	string <= 100 characters 役職英字
post	string <= 50 characters 職務
divisionIds	Array of integers <int64> <= 10 items [ items <int64 > ] 部署識別番号 ※ 重複していた場合は1つ目を登録
comment	string <= 500 characters コメント
remarks	string <= 500 characters 備考
skill	string <= 500 characters スキル
pbxPartition	string <= 50 characters ^$\|^[0-9A-Za-z _-]+$ パーティション ※ CUCM連携利用環境のみ有効
extensionNum	string <= 50 characters [0-9#,;+-] 内線番号
companyMobileNum	string <= 50 characters [0-9#,;+-] 会社携帯番号
personalMobileNum	string <= 50 characters [0-9#,;+-] 個人携帯番号
phoneNum	string <= 50 characters [0-9#,;+-] 電話番号
mobileNum	string <= 50 characters [0-9#,;+-] 携帯番号
faxNum	string <= 50 characters [0-9#,;+-] FAX 番号
email1	string <= 256 characters Eメールアドレス1
email2	string <= 256 characters Eメールアドレス2
webUrl	string <= 256 characters ^(https?://)?[a-zA-Z0-9.!#$%&'*+/=?:^_`{\|}~-]... WEB URL
	Array of objects unique コラボレーション
m365Account	string <= 256 characters ^[0-9A-Za-z.\-_@]*$ Microsoft 365 アカウント
pbxAccount	string <= 256 characters PBXアカウント
iosPasyncLabel	string <= 25 characters PA Sync表示ラベル
spCallSettings	Array of strings unique Items Enum: "DIRECT_CALL" "SETTING_1" "SETTING_2" "SETTING_3" "SETTING_4" "SETTING_5" "SETTING_6" "SETTING_7" "SETTING_8" "SETTING_9" "SETTING_10" スマートフォン発信機能 DIRECT_CALL: 直接発信（デフォルト値） SETTING_1: 発信設定 1 SETTING_2: 発信設定 2 SETTING_3: 発信設定 3 SETTING_4: 発信設定 4 SETTING_5: 発信設定 5 SETTING_6: 発信設定 6 SETTING_7: 発信設定 7 SETTING_8: 発信設定 8 SETTING_9: 発信設定 9 SETTING_10: 発信設定 10 ※ 基本利用ユーザ以外の場合は指定不要 ※ 環境で登録された発信設定のみ有効
roles	Array of strings unique Items Enum: "ADMIN_COMPANY" "ADMIN_DIVISION" "ADMIN_USER" "ADMIN_INTERNAL_CONTACT" "ADMIN_COMMON_CONTACT" "ADMIN_INFORMATION" "ADMIN_SANSAN_IMPORT" "ADMIN_ACTION_LOG" "ADMIN_AZURE_ACTIVE_DIRECTORY" "ADMIN_ACTIVE_DIRECTORY" "ADMIN_CUCM" "ADMIN_DIAL_PICKUP" "ADMIN_CMX" "ADMIN_EX_BEACON" "ADMIN_MERAKI" "ADMIN_ANPI" "ADMIN_IBASHO" "ADMIN_THANKS" "ADMIN_GOTALK" 権限コントロール ADMIN_COMPANY: 企業情報 ADMIN_DIVISION: 部署 ADMIN_USER: ユーザ ADMIN_INTERNAL_CONTACT: 社内電話帳 ADMIN_COMMON_CONTACT: 共有電話帳 ADMIN_INFORMATION: お知らせ ADMIN_ACTION_LOG: ログ出力 ADMIN_ACTIVE_DIRECTORY: AD連携 ADMIN_SANSAN_IMPORT: Sansan連携 ADMIN_CUCM: CUCM連携 ADMIN_GOTALK: トーク ADMIN_DIAL_PICKUP: ダイヤルピックアップ ADMIN_IBASHO: PA PLACE ※1 ADMIN_CMX: Cisco CMX ※2 ADMIN_MERAKI: Cisco MERAKI ※2 ADMIN_EX_BEACON: EXBeacon ※2 ADMIN_THANKS: PA THANKS ADMIN_AZURE_ACTIVE_DIRECTORY: Azure AD連携 ADMIN_ANPI: 安否 ※1 PHONE APPLI PLACE を2019年7月4日以降にご契約の場合、「ADMIN_IBASHO」が有効 ※2 PHONE APPLI PLACE を2019年7月3日以前にご契約の場合、ご利用中の製品・サービスに該当する権限が有効
paapiAvailable	boolean API利用権限
forceRequestOperator	string Default: "DISABLE" Enum: "DISABLE" "FORCE" "SELECT" 名刺オペレータ入力権限 FORCE: 強制 SELECT: 選択 DISABLE: 無効
pbxFeatureAvailable	boolean PBX連携 ※ PBX連携利用環境のみ有効
tenantCucmAdapterSettingsId	integer <int64> CUCMアダプタ設定識別番号 ※ CUCM連携利用環境のみ有効
ctiPort	string <= 15 characters ^$\|^[0-9a-zA-Z._-]+$ CTIポート ※ CUCM連携利用環境のみ有効
incomingPopupIosApns	boolean CUCM iPhone着信通知 ※ CUCM連携利用環境のみ有効
tenantAvayaAdapterSettingsId	integer <int64> Avayaアダプタ設定識別番号 ※ Avaya連携環境のみ有効
gotalkAvailable	boolean トーク ※ トーク利用環境のみ有効
gotalkLogDownloadAvailable	boolean トークログダウンロード ※ トーク利用環境のみ有効
anpiLoginId	string <= 32 characters ^[0-9a-zA-Z]*$ 安否ログインID ※ 安否確認利用環境のみ有効
mobileMacAddress	string^$\|^([0-9A-Fa-f]{2}:){5}[0-9A-Fa-f]{2}$ スマートデバイス ※ PHONE APPLI PLACE 利用環境のみ有効
pcMacAddress	string^$\|^([0-9A-Fa-f]{2}:){5}[0-9A-Fa-f]{2}$ PC ※ PHONE APPLI PLACE 利用環境のみ有効
bleId	string <= 64 characters ^[0-9a-zA-Z:_.@-]*$ 位置情報タグ ※ PHONE APPLI PLACE 利用環境のみ有効
thanksAvailable	boolean PA THANKS ※ PHONE APPLI THANKS 利用環境のみ有効

Responses

Request samples

Payload

Content type

application/json

{"userType": "REGULAR_USER",
"enabled": true,
"forceLocalAuthentication": true,
"deviceId": "string",
"deviceIdAcceptInitialize": true,
"loginId": "string",
"password": "string",
"initialPasswordForceChange": false,
"sortScore": 999999999,
"level": 5,
"fullname": "string",
"fullnameKana": "string",
"fullnameAlphabet": "string",
"employeeNum": "string",
"position": "string",
"positionAlphabet": "string",
"post": "string",
"divisionIds": [0
],
"comment": "string",
"remarks": "string",
"skill": "string",
"pbxPartition": "string",
"extensionNum": "string",
"companyMobileNum": "string",
"personalMobileNum": "string",
"phoneNum": "string",
"mobileNum": "string",
"faxNum": "string",
"email1": "string",
"email2": "string",
"webUrl": "string",
"chatSettingList": [{"chatSettingSeq": 1,
"chatAccountId": "string"
}
],
"m365Account": "string",
"pbxAccount": "string",
"iosPasyncLabel": "string",
"spCallSettings": ["DIRECT_CALL"
],
"roles": ["ADMIN_COMPANY"
],
"paapiAvailable": true,
"forceRequestOperator": "DISABLE",
"pbxFeatureAvailable": true,
"tenantCucmAdapterSettingsId": 0,
"ctiPort": "string",
"incomingPopupIosApns": true,
"tenantAvayaAdapterSettingsId": 0,
"gotalkAvailable": true,
"gotalkLogDownloadAvailable": true,
"anpiLoginId": "string",
"mobileMacAddress": "string",
"pcMacAddress": "string",
"bleId": "string",
"thanksAvailable": true
}

Response samples

201
default

Content type

application/json

{"userId": 0,
"userType": "REGULAR_USER",
"enabled": true,
"forceLocalAuthentication": true,
"deviceId": "string",
"deviceIdAcceptInitialize": true,
"loginId": "string",
"initialPasswordForceChange": true,
"sortScore": 0,
"level": 0,
"fullname": "string",
"fullnameKana": "string",
"fullnameAlphabet": "string",
"employeeNum": "string",
"position": "string",
"positionAlphabet": "string",
"post": "string",
"divisions": [{"divisionId": 0,
"divisionName": "string"
}
],
"comment": "string",
"remarks": "string",
"skill": "string",
"pbxPartition": "string",
"extensionNum": "string",
"companyMobileNum": "string",
"personalMobileNum": "string",
"phoneNum": "string",
"mobileNum": "string",
"faxNum": "string",
"email1": "string",
"email2": "string",
"webUrl": "string",
"collaborations": [{"chatSettingSeq": 0,
"clientName": "string",
"chatAccountId": "string"
}
],
"m365Account": "string",
"pbxAccount": "string",
"iosPasyncLabel": "string",
"spCallSettings": ["DIRECT_CALL"
],
"roles": ["ADMIN_COMPANY"
],
"paapiAvailable": true,
"forceRequestOperator": "DISABLE",
"pbxFeatureAvailable": true,
"tenantCucmAdapterSettings": {"tenantCucmAdapterSettingsId": 0,
"cucmAdapterName": "string"
},
"ctiPort": "string",
"incomingPopupIosApns": true,
"tenantAvayaAdapterSettings": {"tenantAvayaAdapterSettingsId": 0,
"avayaAdapterName": "string"
},
"gotalkAvailable": true,
"gotalkLogDownloadAvailable": true,
"anpiLoginId": "string",
"mobileMacAddress": "string",
"pcMacAddress": "string",
"bleId": "string",
"thanksAvailable": true,
"contactDetailsUrl": "string"
}

社内連絡先取得

社内電話帳に登録された連絡先（ユーザ）の情報を取得できます。権限範囲の項目のみ取得可能です。

Authorizations:

ApiKeyAuth

path Parameters

userId

required

integer <int64>

取得対象のユーザ識別番号
※ 自分の連絡先を取得する場合、ユーザ識別番号の代わりに me も有効

Responses

Response samples

200
default

Content type

application/json

{"userId": 0,
"userType": "REGULAR_USER",
"enabled": true,
"forceLocalAuthentication": true,
"deviceId": "string",
"deviceIdAcceptInitialize": true,
"loginId": "string",
"initialPasswordForceChange": true,
"sortScore": 0,
"level": 0,
"fullname": "string",
"fullnameKana": "string",
"fullnameAlphabet": "string",
"employeeNum": "string",
"position": "string",
"positionAlphabet": "string",
"post": "string",
"divisions": [{"divisionId": 0,
"divisionName": "string"
}
],
"comment": "string",
"remarks": "string",
"skill": "string",
"pbxPartition": "string",
"extensionNum": "string",
"companyMobileNum": "string",
"personalMobileNum": "string",
"phoneNum": "string",
"mobileNum": "string",
"faxNum": "string",
"email1": "string",
"email2": "string",
"webUrl": "string",
"collaborations": [{"chatSettingSeq": 0,
"clientName": "string",
"chatAccountId": "string"
}
],
"m365Account": "string",
"pbxAccount": "string",
"iosPasyncLabel": "string",
"spCallSettings": ["DIRECT_CALL"
],
"roles": ["ADMIN_COMPANY"
],
"paapiAvailable": true,
"forceRequestOperator": "DISABLE",
"pbxFeatureAvailable": true,
"tenantCucmAdapterSettings": {"tenantCucmAdapterSettingsId": 0,
"cucmAdapterName": "string"
},
"ctiPort": "string",
"incomingPopupIosApns": true,
"tenantAvayaAdapterSettings": {"tenantAvayaAdapterSettingsId": 0,
"avayaAdapterName": "string"
},
"gotalkAvailable": true,
"gotalkLogDownloadAvailable": true,
"anpiLoginId": "string",
"mobileMacAddress": "string",
"pcMacAddress": "string",
"bleId": "string",
"thanksAvailable": true,
"contactDetailsUrl": "string"
}

社内連絡先編集

社内電話帳に登録された連絡先（ユーザ）の情報を編集できます。指定した項目のみ変更が反映されます。
※ ご利用にはユーザ管理権限が必要です。

Authorizations:

ApiKeyAuth

path Parameters

userId

required

integer <int64>

編集対象のユーザ識別番号

Request Body schema: application/json
required

userType	string Enum: "REGULAR_USER" "REGISTRATION_ONLY_USER" "FACILITY" ユーザタイプ REGULAR_USER: 基本利用ユーザ REGISTRATION_ONLY_USER: 登録限定ユーザ FACILITY: 施設・備品
enabled	boolean アカウント有効/無効
forceLocalAuthentication	boolean SAML認証または OpenID Connect 利用環境でローカル認証のみに制限
deviceId	string <= 8 characters ^$\|^[0-9a-zA-Z]+$ 端末ID
deviceIdAcceptInitialize	boolean 端末ID 初回認証
password	string <= 50 characters ^(?!(\s\|　)*$).+ パスワード ※ 基本利用ユーザに変更する場合は必須 ※ 基本利用ユーザ以外に変更する場合は指定不要
initialPasswordForceChange	boolean 初期パスワード変更
sortScore	integer <int32> [ 0 .. 999999999 ] ソートスコア
level	integer <int32> [ 1 .. 10 ] レベル
fullname	string <= 50 characters ^(?!(\s\|　)*$).+ 氏名
fullnameKana	string <= 50 characters 氏名カナ
fullnameAlphabet	string <= 50 characters 氏名英字
employeeNum	string <= 50 characters 社員番号
position	string <= 100 characters 役職
positionAlphabet	string <= 100 characters 役職英字
post	string <= 50 characters 職務
divisionIds	Array of integers <int64> <= 10 items [ items <int64 > ] 部署識別番号 ※ 重複していた場合は1つ目を登録
comment	string <= 500 characters コメント
remarks	string <= 500 characters 備考
skill	string <= 500 characters スキル
pbxPartition	string <= 50 characters ^$\|^[0-9A-Za-z _-]+$ パーティション ※ CUCM連携利用環境のみ有効
extensionNum	string <= 50 characters [0-9#,;+-] 内線番号
companyMobileNum	string <= 50 characters [0-9#,;+-] 会社携帯番号
personalMobileNum	string <= 50 characters [0-9#,;+-] 個人携帯番号
phoneNum	string <= 50 characters [0-9#,;+-] 電話番号
mobileNum	string <= 50 characters [0-9#,;+-] 携帯番号
faxNum	string <= 50 characters [0-9#,;+-] FAX番号
email1	string <= 256 characters Eメールアドレス1
email2	string <= 256 characters Eメールアドレス2
webUrl	string <= 256 characters ^(https?://)?[a-zA-Z0-9.!#$%&'*+/=?:^_`{\|}~-]... WEB URL
	Array of objects unique コラボレーション
m365Account	string <= 256 characters ^[0-9A-Za-z.\-_@]*$ Microsoft 365 アカウント
pbxAccount	string <= 256 characters PBXアカウント
iosPasyncLabel	string <= 25 characters PA Sync表示ラベル
spCallSettings	Array of strings unique Items Enum: "DIRECT_CALL" "SETTING_1" "SETTING_2" "SETTING_3" "SETTING_4" "SETTING_5" "SETTING_6" "SETTING_7" "SETTING_8" "SETTING_9" "SETTING_10" スマートフォン発信機能 DIRECT_CALL: 直接発信（デフォルト値） SETTING_1: 発信設定 1 SETTING_2: 発信設定 2 SETTING_3: 発信設定 3 SETTING_4: 発信設定 4 SETTING_5: 発信設定 5 SETTING_6: 発信設定 6 SETTING_7: 発信設定 7 SETTING_8: 発信設定 8 SETTING_9: 発信設定 9 SETTING_10: 発信設定 10 ※ 基本利用ユーザ以外に変更する場合は指定不要 ※ 環境で登録された発信設定のみ有効
roles	Array of strings unique Items Enum: "ADMIN_COMPANY" "ADMIN_DIVISION" "ADMIN_USER" "ADMIN_INTERNAL_CONTACT" "ADMIN_COMMON_CONTACT" "ADMIN_INFORMATION" "ADMIN_SANSAN_IMPORT" "ADMIN_ACTION_LOG" "ADMIN_AZURE_ACTIVE_DIRECTORY" "ADMIN_ACTIVE_DIRECTORY" "ADMIN_CUCM" "ADMIN_DIAL_PICKUP" "ADMIN_CMX" "ADMIN_EX_BEACON" "ADMIN_MERAKI" "ADMIN_ANPI" "ADMIN_IBASHO" "ADMIN_THANKS" "ADMIN_GOTALK" 権限コントロール ADMIN_COMPANY: 企業情報 ADMIN_DIVISION: 部署 ADMIN_USER: ユーザ ADMIN_INTERNAL_CONTACT: 社内電話帳 ADMIN_COMMON_CONTACT: 共有電話帳 ADMIN_INFORMATION: お知らせ ADMIN_ACTION_LOG: ログ出力 ADMIN_ACTIVE_DIRECTORY: AD連携 ADMIN_SANSAN_IMPORT: Sansan連携 ADMIN_CUCM: CUCM連携 ADMIN_GOTALK: トーク ADMIN_DIAL_PICKUP: ダイヤルピックアップ ADMIN_IBASHO: PA PLACE ※1 ADMIN_CMX: Cisco CMX ※2 ADMIN_MERAKI: Cisco MERAKI ※2 ADMIN_EX_BEACON: EXBeacon ※2 ADMIN_THANKS: PA THANKS ADMIN_AZURE_ACTIVE_DIRECTORY: Azure AD連携 ADMIN_ANPI: 安否 ※1 PHONE APPLI PLACE を2019年7月4日以降にご契約の場合、「ADMIN_IBASHO」が有効 ※2 PHONE APPLI PLACE を2019年7月3日以前にご契約の場合、ご利用中の製品・サービスに該当する権限が有効
paapiAvailable	boolean API利用権限
forceRequestOperator	string Enum: "DISABLE" "FORCE" "SELECT" 名刺オペレータ入力権限 FORCE: 強制 SELECT: 選択 DISABLE: 無効
pbxFeatureAvailable	boolean PBX連携 ※ PBX連携利用環境のみ有効
tenantCucmAdapterSettingsId	integer <int64> CUCMアダプタ設定識別番号 ※ 0を指定すると初期化 ※ CUCM連携利用環境のみ有効
ctiPort	string <= 15 characters ^$\|^[0-9a-zA-Z._-]+$ CTIポート ※ CUCM連携利用環境のみ有効
incomingPopupIosApns	boolean CUCM iPhone着信通知 ※ CUCM連携利用環境のみ有効
tenantAvayaAdapterSettingsId	integer <int64> Avayaアダプタ設定識別番号 ※ 0を指定すると初期化 ※ Avaya連携環境のみ有効
gotalkAvailable	boolean トーク ※ トーク利用環境のみ有効
gotalkLogDownloadAvailable	boolean トークログダウンロード ※ トーク利用環境のみ有効
anpiLoginId	string <= 32 characters ^[0-9a-zA-Z]*$ 安否ログインID ※ 安否確認利用環境のみ有効
mobileMacAddress	string^$\|^([0-9A-Fa-f]{2}:){5}[0-9A-Fa-f]{2}$ スマートデバイス ※ PHONE APPLI PLACE 利用環境のみ有効
pcMacAddress	string^$\|^([0-9A-Fa-f]{2}:){5}[0-9A-Fa-f]{2}$ PC ※ PHONE APPLI PLACE 利用環境のみ有効
bleId	string <= 64 characters ^[0-9a-zA-Z:_.@-]*$ 位置情報タグ ※ PHONE APPLI PLACE 利用環境のみ有効
thanksAvailable	boolean PA THANKS ※ PHONE APPLI THANKS 利用環境のみ有効

Responses

Request samples

Payload

Content type

application/json

{"userType": "REGULAR_USER",
"enabled": true,
"forceLocalAuthentication": true,
"deviceId": "string",
"deviceIdAcceptInitialize": true,
"password": "string",
"initialPasswordForceChange": true,
"sortScore": 999999999,
"level": 1,
"fullname": "string",
"fullnameKana": "string",
"fullnameAlphabet": "string",
"employeeNum": "string",
"position": "string",
"positionAlphabet": "string",
"post": "string",
"divisionIds": [0
],
"comment": "string",
"remarks": "string",
"skill": "string",
"pbxPartition": "string",
"extensionNum": "string",
"companyMobileNum": "string",
"personalMobileNum": "string",
"phoneNum": "string",
"mobileNum": "string",
"faxNum": "string",
"email1": "string",
"email2": "string",
"webUrl": "string",
"chatSettingList": [{"chatSettingSeq": 1,
"chatAccountId": "string"
}
],
"m365Account": "string",
"pbxAccount": "string",
"iosPasyncLabel": "string",
"spCallSettings": ["DIRECT_CALL"
],
"roles": ["ADMIN_COMPANY"
],
"paapiAvailable": true,
"forceRequestOperator": "DISABLE",
"pbxFeatureAvailable": true,
"tenantCucmAdapterSettingsId": 0,
"ctiPort": "string",
"incomingPopupIosApns": true,
"tenantAvayaAdapterSettingsId": 0,
"gotalkAvailable": true,
"gotalkLogDownloadAvailable": true,
"anpiLoginId": "string",
"mobileMacAddress": "string",
"pcMacAddress": "string",
"bleId": "string",
"thanksAvailable": true
}

Response samples

200
default

Content type

application/json

{"userId": 0,
"userType": "REGULAR_USER",
"enabled": true,
"forceLocalAuthentication": true,
"deviceId": "string",
"deviceIdAcceptInitialize": true,
"loginId": "string",
"initialPasswordForceChange": true,
"sortScore": 0,
"level": 0,
"fullname": "string",
"fullnameKana": "string",
"fullnameAlphabet": "string",
"employeeNum": "string",
"position": "string",
"positionAlphabet": "string",
"post": "string",
"divisions": [{"divisionId": 0,
"divisionName": "string"
}
],
"comment": "string",
"remarks": "string",
"skill": "string",
"pbxPartition": "string",
"extensionNum": "string",
"companyMobileNum": "string",
"personalMobileNum": "string",
"phoneNum": "string",
"mobileNum": "string",
"faxNum": "string",
"email1": "string",
"email2": "string",
"webUrl": "string",
"collaborations": [{"chatSettingSeq": 0,
"clientName": "string",
"chatAccountId": "string"
}
],
"m365Account": "string",
"pbxAccount": "string",
"iosPasyncLabel": "string",
"spCallSettings": ["DIRECT_CALL"
],
"roles": ["ADMIN_COMPANY"
],
"paapiAvailable": true,
"forceRequestOperator": "DISABLE",
"pbxFeatureAvailable": true,
"tenantCucmAdapterSettings": {"tenantCucmAdapterSettingsId": 0,
"cucmAdapterName": "string"
},
"ctiPort": "string",
"incomingPopupIosApns": true,
"tenantAvayaAdapterSettings": {"tenantAvayaAdapterSettingsId": 0,
"avayaAdapterName": "string"
},
"gotalkAvailable": true,
"gotalkLogDownloadAvailable": true,
"anpiLoginId": "string",
"mobileMacAddress": "string",
"pcMacAddress": "string",
"bleId": "string",
"thanksAvailable": true,
"contactDetailsUrl": "string"
}

社内連絡先削除

社内電話帳に登録された連絡先（ユーザ）を削除できます。
※ 顔写真も含まれます。
※ ご利用にはユーザ管理権限が必要です。

Authorizations:

ApiKeyAuth

path Parameters

userId

required

integer <int64>

削除対象のユーザ識別番号

Responses

Response samples

default

Content type

application/json

{"error": {"status": "INVALID_ARGUMENT",
"message": "string",
"details": [{"field": "string",
"code": "string",
"description": "string"
}
]
}
}

顔写真取得

社内電話帳に登録された連絡先（ユーザ）の顔写真をJPEG形式で取得できます。
取得できるのは、権限範囲のユーザの顔写真です。

Authorizations:

ApiKeyAuth

path Parameters

userId

required

integer <int64>

取得対象のユーザ識別番号
※ 自分の顔写真を取得する場合、ユーザ識別番号の代わりに me も有効

query Parameters

size	string Default: "FULL" Enum: "FULL" "THUMBNAIL" 画像サイズ FULL: フルサイズ THUMBNAIL: サムネイル

Responses

Response samples

default

Content type

application/json

{"error": {"status": "INVALID_ARGUMENT",
"message": "string",
"details": [{"field": "string",
"code": "string",
"description": "string"
}
]
}
}

顔写真更新

社内電話帳に登録された連絡先（ユーザ）の顔写真を更新できます。
※ ご利用にはユーザ管理権限が必要です。

Authorizations:

ApiKeyAuth

path Parameters

userId

required

integer <int64>

更新対象のユーザ識別番号

Request Body schema:
image/jpeg
required

string <binary>

顔写真

画像のファイル形式：JPEG（*.jpg,*.jpeg）

Responses

Response samples

default

Content type

application/json

{"error": {"status": "INVALID_ARGUMENT",
"message": "string",
"details": [{"field": "string",
"code": "string",
"description": "string"
}
]
}
}

顔写真削除

社内電話帳に登録された連絡先（ユーザ）の顔写真を削除できます。
※ ご利用にはユーザ管理権限が必要です。

Authorizations:

ApiKeyAuth

path Parameters

userId

required

integer <int64>

削除対象のユーザ識別番号

Responses

Response samples

default

Content type

application/json

{"error": {"status": "INVALID_ARGUMENT",
"message": "string",
"details": [{"field": "string",
"code": "string",
"description": "string"
}
]
}
}

プロフィール

PA PEOPLE の社内電話帳の連絡先（ユーザ）に紐づくプロフィールです。

プロフィール取得

プロフィールの情報を取得できます。

Authorizations:

ApiKeyAuth

path Parameters

userId

required

integer <int64>

取得対象のユーザ識別番号
※ 自分のプロフィール（マイプロフィール）を取得する場合、ユーザ識別番号の代わりに me も有効

Responses

Response samples

200
default

Content type

application/json

{"oneWord": "string",
"jobDescription": "string",
"skills": ["string"
],
"toolTechnologies": ["string"
],
"qualifications": ["string"
],
"briefHistories": [{"briefHistoryDate": "2019-08-24",
"briefHistoryText": "string"
}
],
"achievementHistories": [{"achievementHistoryDate": "2019-08-24",
"achievementHistoryText": "string"
}
],
"externalLinks": [{"externalLinkUrl": "string",
"externalLinkTitle": "string"
}
],
"customColumns": [{"customColumnId": 0,
"customColumnTitle": "string",
"customColumnValue": "string"
}
],
"selfUpdatedAt": "2019-08-24T14:15:22.323+09:00"
}

プロフィール編集

プロフィールの情報を編集できます。指定した項目のみ変更が反映されます。
※ 自分以外のプロフィールを編集する場合、ユーザ管理権限が必要

Authorizations:

ApiKeyAuth

path Parameters

userId

required

integer <int64>

編集対象のユーザ識別番号
※ 自分のプロフィール（マイプロフィール）を編集する場合、ユーザ識別番号の代わりに me も有効

Request Body schema: application/json
required

oneWord	string <= 280 characters ひとこと
jobDescription	string <= 280 characters 職務概要
skills	Array of strings <= 20 items [^(?!(\s\|　)*$).+] スキル ※ 指定した順で登録される。なお、スキルが重複していた場合、1つ目だけが登録される ※ 他のユーザが文字種違いのスキルを登録していた場合、既存のスキルの表記に統合される（例：他のユーザが「マネジメント」を登録していて、APIで「まねじめんと」を指定した場合、既存の「マネジメント」で登録される）
toolTechnologies	Array of strings <= 20 items [^(?!(\s\|　)*$).+] ツール&テクノロジー ※ 指定した順で登録される。なお、ツール&テクノロジーが重複していた場合、1つ目だけが登録される ※ 他のユーザが文字種違いのツール&テクノロジーを登録していた場合、既存のツール&テクノロジーの表記に統合される（例：他のユーザが「Tech X」を登録していて、APIで「tech ｘ」を指定した場合、既存の「Tech X」で登録される）
qualifications	Array of strings <= 20 items [^(?!(\s\|　)*$).+] 資格 ※ 指定した順で登録される。なお、資格が重複していた場合、1つ目だけが登録される ※ 他のユーザが文字種違いの資格を登録していた場合、既存の資格の表記に統合される（例：他のユーザが「社内資格　１級」を登録していて、APIで「社内資格 1級」を指定した場合、既存の「社内資格　１級」で登録される）
	Array of objects <= 30 items 略歴
	Array of objects <= 30 items 実績・受賞歴
	Array of objects <= 3 items 外部リンク
	Array of objects <= 3 items カスタマイズ項目 ※ 重複していた場合は1つ目を登録

Responses

Request samples

Payload

Content type

application/json

{"oneWord": "string",
"jobDescription": "string",
"skills": ["string"
],
"toolTechnologies": ["string"
],
"qualifications": ["string"
],
"briefHistories": [{"briefHistoryDate": "2019-08-24",
"briefHistoryText": "string"
}
],
"achievementHistories": [{"achievementHistoryDate": "2019-08-24",
"achievementHistoryText": "string"
}
],
"externalLinks": [{"externalLinkUrl": "string",
"externalLinkTitle": "string"
}
],
"customColumns": [{"customColumnId": 0,
"customColumnValue": "string"
}
]
}

Response samples

200
default

Content type

application/json

{"oneWord": "string",
"jobDescription": "string",
"skills": ["string"
],
"toolTechnologies": ["string"
],
"qualifications": ["string"
],
"briefHistories": [{"briefHistoryDate": "2019-08-24",
"briefHistoryText": "string"
}
],
"achievementHistories": [{"achievementHistoryDate": "2019-08-24",
"achievementHistoryText": "string"
}
],
"externalLinks": [{"externalLinkUrl": "string",
"externalLinkTitle": "string"
}
],
"customColumns": [{"customColumnId": 0,
"customColumnTitle": "string",
"customColumnValue": "string"
}
],
"selfUpdatedAt": "2019-08-24T14:15:22.323+09:00"
}

行き先

PA PEOPLE の社内電話帳の連絡先（ユーザ）に紐づく行き先です。

行き先一括編集

ユーザごとの行き先を一括して編集できます。
※ ご利用にはユーザ管理権限が必要です。

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

required

Array of objects <= 10000 items

行き先情報

Responses

Request samples

Payload

Content type

application/json

{"destinations": [{"loginId": "string",
"destinationId": 0,
"destinationName": "string"
}
]
}

Response samples

200
default

Content type

application/json

{"destinationsCount": 0,
"registeredCount": 0
}

部署

PA PEOPLE の社内電話帳の部署です。

部署一覧取得

部署の情報を一覧で取得できます。

Authorizations:

ApiKeyAuth

query Parameters

page	integer <int32> >= 0 Default: 0 取得対象ページの番号
pageSize	integer <int32> [ 1 .. 100 ] Default: 30 1ページあたりの件数
divisionIds	Array of integers <int64> <= 50 items [ items <int64 > ] 取得対象の部署識別番号
divisionCodes	Array of strings <= 50 items [^[0-9a-zA-Z\-_.@(){}\[\]]+$] 取得対象の部署コード（完全一致）
divisionName	string 取得対象の部署名（部分一致）
firstLayer	boolean Default: false 取得対象を親部署がない部署に限定

Responses

Response samples

200
default

Content type

application/json

{"hasMore": true,
"items": [{"divisionId": 0,
"parentDivisionId": 0,
"childDivisionIds": [0
],
"divisionCode": "string",
"divisionName": "string",
"divisionNameKana": "string",
"divisionNameAlphabet": "string",
"divisionPhoneNum": "string",
"divisionUrl": "string",
"sortScore": 0
}
]
}

部署作成

部署を作成できます。
※ ご利用には部署管理権限が必要です。

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

parentDivisionId	integer <int64> >= 1 親部署識別番号 ※ 所属する親部署がない場合は指定不要
divisionCode required	string <= 100 characters ^[0-9a-zA-Z\-_.@(){}\[\]]+$ 部署コード
divisionName required	string <= 100 characters ^(?!(\s\|　)*$).+ 部署名
divisionNameKana	string <= 100 characters 部署名カナ
divisionNameAlphabet	string <= 100 characters 部署名英字
divisionPhoneNum	string <= 50 characters [0-9#,;+-] 部署代表番号
divisionUrl	string <= 256 characters ^(https?://)?[a-zA-Z0-9.!#$%&'*+/=?:^_`{\|}~-]... 部署URL
sortScore	integer <int32> [ 0 .. 999999999 ] ソートスコア

Responses

Request samples

Payload

Content type

application/json

{"parentDivisionId": 1,
"divisionCode": "string",
"divisionName": "string",
"divisionNameKana": "string",
"divisionNameAlphabet": "string",
"divisionPhoneNum": "string",
"divisionUrl": "string",
"sortScore": 999999999
}

Response samples

201
default

Content type

application/json

{"divisionId": 0,
"parentDivisionId": 0,
"childDivisionIds": [0
],
"divisionCode": "string",
"divisionName": "string",
"divisionNameKana": "string",
"divisionNameAlphabet": "string",
"divisionPhoneNum": "string",
"divisionUrl": "string",
"sortScore": 0
}

部署取得

部署の情報を取得できます。

Authorizations:

ApiKeyAuth

path Parameters

divisionId

required

integer <int64>

取得対象の部署識別番号

Responses

Response samples

200
default

Content type

application/json

{"divisionId": 0,
"parentDivisionId": 0,
"childDivisionIds": [0
],
"divisionCode": "string",
"divisionName": "string",
"divisionNameKana": "string",
"divisionNameAlphabet": "string",
"divisionPhoneNum": "string",
"divisionUrl": "string",
"sortScore": 0
}

部署編集

部署の情報を編集できます。指定した項目のみ変更が反映されます。
※ ご利用には部署管理権限が必要です。

Authorizations:

ApiKeyAuth

path Parameters

divisionId

required

integer <int64>

編集対象の部署識別番号

Request Body schema: application/json
required

parentDivisionId	integer <int64> >= 0 親部署識別番号 ※ 所属する親部署がない場合は0を指定
divisionCode	string <= 100 characters ^[0-9a-zA-Z\-_.@(){}\[\]]+$ 部署コード
divisionName	string <= 100 characters ^(?!(\s\|　)*$).+ 部署名
divisionNameKana	string <= 100 characters 部署名カナ
divisionNameAlphabet	string <= 100 characters 部署名英字
divisionPhoneNum	string <= 50 characters [0-9#,;+-] 部署代表番号
divisionUrl	string <= 256 characters ^(https?://)?[a-zA-Z0-9.!#$%&'*+/=?:^_`{\|}~-]... 部署URL
sortScore	integer <int32> [ 0 .. 999999999 ] ソートスコア

Responses

Request samples

Payload

Content type

application/json

{"parentDivisionId": 0,
"divisionCode": "string",
"divisionName": "string",
"divisionNameKana": "string",
"divisionNameAlphabet": "string",
"divisionPhoneNum": "string",
"divisionUrl": "string",
"sortScore": 999999999
}

Response samples

200
default

Content type

application/json

{"divisionId": 0,
"parentDivisionId": 0,
"childDivisionIds": [0
],
"divisionCode": "string",
"divisionName": "string",
"divisionNameKana": "string",
"divisionNameAlphabet": "string",
"divisionPhoneNum": "string",
"divisionUrl": "string",
"sortScore": 0
}

部署削除

部署を削除できます。親部署を削除した場合、配下に含まれる部署も削除されます。
※ ご利用には部署管理権限が必要です。

Authorizations:

ApiKeyAuth

path Parameters

divisionId

required

integer <int64>

削除対象の部署識別番号

Responses

Response samples

default

Content type

application/json

{"error": {"status": "INVALID_ARGUMENT",
"message": "string",
"details": [{"field": "string",
"code": "string",
"description": "string"
}
]
}
}

社外連絡先

PA PEOPLE の社外電話帳の連絡先です。

社外連絡先一覧取得

社外電話帳（共有/個人）に登録された連絡先の情報を一覧で取得できます。
取得できるのは、閲覧権限があるフォルダ内の連絡先です。

Authorizations:

ApiKeyAuth

query Parameters

page	integer <int32> [ 0 .. 19 ] Default: 0 取得対象ページの番号
pageSize	integer <int32> [ 1 .. 500 ] Default: 30 1ページあたりの件数
select	Array of strings Items Enum: "contactId" "folderId" "companyName" "companyNameKana" "companyDelegatedPhoneNum" "companyUrl" "headquartersLocation" "divisionName" "divisionNameKana" "divisionDelegatedPhoneNum" "divisionUrl" "officeLocation" "position" "fullname" "fullnameKana" "fullnameAlphabet" "phoneNum" "companyMobileNum" "personalMobileNum" "mobileNum" "faxNum" "email1" "email2" "webUrl" "comment" "remarks" "ocrStatus" "ocrType" "ocrResult" "contactDetailsUrl" "registeredUser" "registeredAt" "updatedAt" 取得対象項目
orderBy	string Default: "updatedAt" Enum: "updatedAt" "fullname" ソートの対象 updatedAt: 更新日時順 fullname: 氏名カナ順
orderDirection	string Default: "asc" Enum: "asc" "desc" ソートの並び順 asc: 昇順 desc: 降順
updatedFrom	string <date-time> 更新日時 from ※ YYYY-MM-DDThh:mm:ss.SSSTZD 形式 ※ updatedTo 以前の日時
updatedTo	string <date-time> 更新日時 to ※ YYYY-MM-DDThh:mm:ss.SSSTZD 形式 ※ updatedFrom 以降の日時
registeredUserId	integer <int64> 登録者のユーザ識別番号
fullname	string <= 50 characters 取得対象の氏名（部分一致）
fullnameKana	string <= 50 characters 取得対象の氏名カナ（部分一致）
phoneNum	string <= 50 characters [0-9#,;+-] 取得対象の電話番号 ※ PA PEOPLEでは、電話番号は「+」（先頭以外）と「-」を含まない書式で登録されている（例：APIで「+81-3-1234-5678」を指定した場合、「+81312345678」と登録されている連絡先を取得できる） ※ 部分一致検索不可
email	string <= 256 characters 取得対象のEメールアドレス（完全一致）
companyName	string <= 200 characters 取得対象の会社名（部分一致）
companyNameKana	string <= 200 characters 取得対象の会社名カナ（部分一致）
divisionName	string <= 50 characters 取得対象の部署名（部分一致）
divisionNameKana	string <= 50 characters 取得対象の部署名カナ（部分一致）
freeWords	Array of strings <= 10 items フリーワード検索 ※ カンマ区切りで AND 検索 ※ 次の項目との同時指定不可 registeredUserId fullname fullnameKana phoneNum email companyName companyNameKana divisionName divisionNameKana
directory	string Enum: "SHARED" "PERSONAL" 取得対象の電話帳タイプ SHARED: 共有電話帳 PERSONAL: 個人電話帳
folderNums	Array of integers <int64> <= 10 items [ items <int64 > ] 取得対象のフォルダ識別番号 ※ directory の指定必須
ocrStatus	string Enum: "CAN_SEND" "SENDING" 取得対象の名刺依頼状態 CAN_SEND: 依頼可能 SENDING: 依頼中
ocrType	string Enum: "NONE" "MACHINE" "OPERATOR" 取得対象の名刺依頼種別 NONE: なし MACHINE: OCR名刺登録 OPERATOR: 名刺オペレータ入力
ocrResult	string Enum: "SUCCESS" "FAILURE" 取得対象の名刺依頼結果 SUCCESS: 成功 FAILURE: 失敗
identified	boolean Default: false 取得対象を名寄せ後の連絡先のみに限定 ※ registeredUserId との同時指定不可

Responses

Response samples

200
default

Content type

application/json

{"hasMore": true,
"items": [{"contactId": 0,
"folderId": {"directory": "SHARED",
"folderNum": 0
},
"companyName": "string",
"companyNameKana": "string",
"companyDelegatedPhoneNum": "string",
"companyUrl": "string",
"headquartersLocation": {"zipCode": "string",
"address1": "string",
"address2": "string"
},
"divisionName": "string",
"divisionNameKana": "string",
"divisionDelegatedPhoneNum": "string",
"divisionUrl": "string",
"officeLocation": {"zipCode": "string",
"address1": "string",
"address2": "string"
},
"position": "string",
"fullname": "string",
"fullnameKana": "string",
"fullnameAlphabet": "string",
"phoneNum": "string",
"companyMobileNum": "string",
"personalMobileNum": "string",
"mobileNum": "string",
"faxNum": "string",
"email1": "string",
"email2": "string",
"webUrl": "string",
"comment": "string",
"remarks": "string",
"ocrStatus": "CAN_SEND",
"ocrType": "NONE",
"ocrResult": "SUCCESS",
"contactDetailsUrl": "string",
"registeredUser": {"userId": 0,
"fullname": "string",
"loginId": "string",
"divisions": [{"divisionId": 0,
"divisionName": "string"
}
]
},
"registeredAt": "2019-08-24T14:15:22+09:00",
"updatedAt": "2019-08-24T14:15:22.323+09:00"
}
]
}

社外連絡先作成

社外連絡先（共有/個人）を作成できます。
作成できるのは、編集権限があるフォルダ内の連絡先です。

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

required	object フォルダ識別子
companyName	string <= 200 characters 会社名
companyNameKana	string <= 200 characters 会社名カナ
companyDelegatedPhoneNum	string <= 50 characters [0-9#,;+-] 会社代表番号
companyUrl	string <= 256 characters ^$\|^https?://[a-zA-Z0-9.!#$%&'*+/=?:^_`{\|}~-]... 会社URL
	object 本社所在地
divisionName	string <= 50 characters 部署名
divisionNameKana	string <= 50 characters 部署名カナ
divisionDelegatedPhoneNum	string <= 50 characters [0-9#,;+-] 部署代表番号
divisionUrl	string <= 256 characters ^$\|^https?://[a-zA-Z0-9.!#$%&'*+/=?:^_`{\|}~-]... 部署URL
	object オフィス所在地
position	string <= 100 characters 役職
fullname required	string <= 50 characters ^(?!(\s\|　)*$).+ 氏名
fullnameKana	string <= 50 characters 氏名カナ
fullnameAlphabet	string <= 50 characters 氏名英字
phoneNum	string <= 50 characters [0-9#,;+-] 電話番号
companyMobileNum	string <= 50 characters [0-9#,;+-] 会社携帯番号
personalMobileNum	string <= 50 characters [0-9#,;+-] 個人携帯番号
mobileNum	string <= 50 characters [0-9#,;+-] 携帯番号
faxNum	string <= 50 characters [0-9#,;+-] FAX番号
email1	string <= 256 characters Eメールアドレス1
email2	string <= 256 characters Eメールアドレス2
webUrl	string <= 256 characters ^$\|^https?://[a-zA-Z0-9.!#$%&'*+/=?:^_`{\|}~-]... Web URL
comment	string <= 500 characters コメント
remarks	string <= 500 characters 備考

Responses

Request samples

Payload

Content type

application/json

{"folderId": {"directory": "SHARED",
"folderNum": 1
},
"companyName": "string",
"companyNameKana": "string",
"companyDelegatedPhoneNum": "string",
"companyUrl": "string",
"headquartersLocation": {"zipCode": "string",
"address1": "string",
"address2": "string"
},
"divisionName": "string",
"divisionNameKana": "string",
"divisionDelegatedPhoneNum": "string",
"divisionUrl": "string",
"officeLocation": {"zipCode": "string",
"address1": "string",
"address2": "string"
},
"position": "string",
"fullname": "string",
"fullnameKana": "string",
"fullnameAlphabet": "string",
"phoneNum": "string",
"companyMobileNum": "string",
"personalMobileNum": "string",
"mobileNum": "string",
"faxNum": "string",
"email1": "string",
"email2": "string",
"webUrl": "string",
"comment": "string",
"remarks": "string"
}

Response samples

201
default

Content type

application/json

{"contactId": 0,
"folderId": {"directory": "SHARED",
"folderNum": 0
},
"companyName": "string",
"companyNameKana": "string",
"companyDelegatedPhoneNum": "string",
"companyUrl": "string",
"headquartersLocation": {"zipCode": "string",
"address1": "string",
"address2": "string"
},
"divisionName": "string",
"divisionNameKana": "string",
"divisionDelegatedPhoneNum": "string",
"divisionUrl": "string",
"officeLocation": {"zipCode": "string",
"address1": "string",
"address2": "string"
},
"position": "string",
"fullname": "string",
"fullnameKana": "string",
"fullnameAlphabet": "string",
"phoneNum": "string",
"companyMobileNum": "string",
"personalMobileNum": "string",
"mobileNum": "string",
"faxNum": "string",
"email1": "string",
"email2": "string",
"webUrl": "string",
"comment": "string",
"remarks": "string",
"ocrStatus": "CAN_SEND",
"ocrType": "NONE",
"ocrResult": "SUCCESS",
"contactDetailsUrl": "string",
"registeredUser": {"userId": 0,
"fullname": "string",
"loginId": "string",
"divisions": [{"divisionId": 0,
"divisionName": "string"
}
]
},
"registeredAt": "2019-08-24T14:15:22+09:00",
"updatedAt": "2019-08-24T14:15:22.323+09:00"
}

社外連絡先編集

社外連絡先（共有/個人）の情報を編集できます。指定した項目のみ変更が反映されます。
編集できるのは、編集権限があるフォルダ内の連絡先です。

Authorizations:

ApiKeyAuth

path Parameters

contactId

required

integer <int64>

編集対象の社外連絡先識別番号

Request Body schema: application/json
required

companyName	string <= 200 characters 会社名
companyNameKana	string <= 200 characters 会社名カナ
companyDelegatedPhoneNum	string <= 50 characters [0-9#,;+-] 会社代表番号
companyUrl	string <= 256 characters ^$\|^https?://[a-zA-Z0-9.!#$%&'*+/=?:^_`{\|}~-]... 会社URL
	object 本社所在地
divisionName	string <= 50 characters 部署名
divisionNameKana	string <= 50 characters 部署名カナ
divisionDelegatedPhoneNum	string <= 50 characters [0-9#,;+-] 部署代表番号
divisionUrl	string <= 256 characters ^$\|^https?://[a-zA-Z0-9.!#$%&'*+/=?:^_`{\|}~-]... 部署URL
	object オフィス所在地
position	string <= 100 characters 役職
fullname	string <= 50 characters ^(?!(\s\|　)*$).+ 氏名
fullnameKana	string <= 50 characters 氏名カナ
fullnameAlphabet	string <= 50 characters 氏名英字
phoneNum	string <= 50 characters [0-9#,;+-] 電話番号
companyMobileNum	string <= 50 characters [0-9#,;+-] 会社携帯番号
personalMobileNum	string <= 50 characters [0-9#,;+-] 個人携帯番号
mobileNum	string <= 50 characters [0-9#,;+-] 携帯番号
faxNum	string <= 50 characters [0-9#,;+-] FAX番号
email1	string <= 256 characters Eメールアドレス1
email2	string <= 256 characters Eメールアドレス2
webUrl	string <= 256 characters ^$\|^https?://[a-zA-Z0-9.!#$%&'*+/=?:^_`{\|}~-]... Web URL
comment	string <= 500 characters コメント
remarks	string <= 500 characters 備考

Responses

Request samples

Payload

Content type

application/json

{"companyName": "string",
"companyNameKana": "string",
"companyDelegatedPhoneNum": "string",
"companyUrl": "string",
"headquartersLocation": {"zipCode": "string",
"address1": "string",
"address2": "string"
},
"divisionName": "string",
"divisionNameKana": "string",
"divisionDelegatedPhoneNum": "string",
"divisionUrl": "string",
"officeLocation": {"zipCode": "string",
"address1": "string",
"address2": "string"
},
"position": "string",
"fullname": "string",
"fullnameKana": "string",
"fullnameAlphabet": "string",
"phoneNum": "string",
"companyMobileNum": "string",
"personalMobileNum": "string",
"mobileNum": "string",
"faxNum": "string",
"email1": "string",
"email2": "string",
"webUrl": "string",
"comment": "string",
"remarks": "string"
}

Response samples

200
default

Content type

application/json

{"contactId": 0,
"folderId": {"directory": "SHARED",
"folderNum": 0
},
"companyName": "string",
"companyNameKana": "string",
"companyDelegatedPhoneNum": "string",
"companyUrl": "string",
"headquartersLocation": {"zipCode": "string",
"address1": "string",
"address2": "string"
},
"divisionName": "string",
"divisionNameKana": "string",
"divisionDelegatedPhoneNum": "string",
"divisionUrl": "string",
"officeLocation": {"zipCode": "string",
"address1": "string",
"address2": "string"
},
"position": "string",
"fullname": "string",
"fullnameKana": "string",
"fullnameAlphabet": "string",
"phoneNum": "string",
"companyMobileNum": "string",
"personalMobileNum": "string",
"mobileNum": "string",
"faxNum": "string",
"email1": "string",
"email2": "string",
"webUrl": "string",
"comment": "string",
"remarks": "string",
"ocrStatus": "CAN_SEND",
"ocrType": "NONE",
"ocrResult": "SUCCESS",
"contactDetailsUrl": "string",
"registeredUser": {"userId": 0,
"fullname": "string",
"loginId": "string",
"divisions": [{"divisionId": 0,
"divisionName": "string"
}
]
},
"registeredAt": "2019-08-24T14:15:22+09:00",
"updatedAt": "2019-08-24T14:15:22.323+09:00"
}

社外連絡先削除

社外連絡先（共有/個人）の情報を削除できます。
削除できるのは、編集権限があるフォルダ内の連絡先です。
※ 名刺画像も含まれます。
※ グループに当該連絡先が登録されている場合は、グループからも削除されます。

Authorizations:

ApiKeyAuth

path Parameters

contactId

required

integer <int64>

削除対象の社外連絡先識別番号

Responses

Response samples

default

Content type

application/json

{"error": {"status": "INVALID_ARGUMENT",
"message": "string",
"details": [{"field": "string",
"code": "string",
"description": "string"
}
]
}
}

名刺読み取り

名刺画像から社外連絡先を作成できます。

Authorizations:

ApiKeyAuth

Request Body schema: multipart/form-data

businessCardImage required	string <binary> 名刺画像ファイル（推奨上限：6 MB）画像のファイル形式 JPEG（.jpg,.jpeg） PNG（.png） GIF（.gif）
directory required	string Enum: "SHARED" "PERSONAL" 登録先の電話帳タイプ SHARED: 共有電話帳 PERSONAL: 個人電話帳
folderNum required	integer <int64> >= 1 登録先のフォルダ識別番号
autoCrop	boolean Default: false 名刺画像の自動トリミング ※ divideImage との同時指定不可
divideImage	boolean Default: false 複数の名刺が含まれる画像を分割 ※ 最大21分割 ※ 次の項目との同時指定不可 autoCrop comment remarks 自動分割できない画像名刺が重なっている画像が鮮明でない名刺と背景（黒推奨）のコントラストが不十分
readerType	string Default: "AUTO" Enum: "AUTO" "OPERATOR" 読み取り方法 AUTO: OCR 優先（名刺オペレータ入力権限が「強制」の場合はオペレータ入力） OPERATOR: オペレータ入力
ocrLanguage	string Default: "JAPANESE" Enum: "JAPANESE" "ENGLISH" 読み取り言語（OCR） JAPANESE: 日本語 ENGLISH: 英語
comment	string <= 500 characters コメント ※ 指定した内容はそのまま連絡先に登録される（OCR・オペレータの読み取り対象外） ※ divideImage との同時指定不可
remarks	string <= 500 characters 備考 ※ 指定した内容はそのまま連絡先に登録される（OCR・オペレータの読み取り対象外） ※ divideImage との同時指定不可

Responses

Response samples

202
default

Content type

application/json

{"contactId": 0
}

名刺画像取得

社外電話帳（共有/個人）に登録された連絡先の名刺画像をJPEG形式で取得できます。
取得できるのは、閲覧権限があるフォルダ内の連絡先の名刺画像です。

Authorizations:

ApiKeyAuth

path Parameters

contactId

required

integer <int64>

取得対象の社外連絡先識別番号

Responses

Response samples

default

Content type

application/json

{"error": {"status": "INVALID_ARGUMENT",
"message": "string",
"details": [{"field": "string",
"code": "string",
"description": "string"
}
]
}
}

名刺画像更新

社外電話帳（共有/個人）に登録された連絡先の名刺画像を更新できます。
更新できるのは、編集権限があるフォルダ内の連絡先の名刺画像です。

Authorizations:

ApiKeyAuth

path Parameters

contactId

required

integer <int64>

更新対象の社外連絡先識別番号

Request Body schema:
image/jpeg
required

string <binary>

名刺画像

画像のファイル形式：JPEG（*.jpg,*.jpeg）
OCR名刺登録や名刺オペレータ入力を依頼する場合の推奨上限：6 MB

Responses

Response samples

default

Content type

application/json

{"error": {"status": "INVALID_ARGUMENT",
"message": "string",
"details": [{"field": "string",
"code": "string",
"description": "string"
}
]
}
}

名刺画像削除

社外電話帳（共有/個人）に登録された連絡先の名刺画像を削除できます。
削除できるのは、編集権限があるフォルダ内の連絡先の名刺画像です。

Authorizations:

ApiKeyAuth

path Parameters

contactId

required

integer <int64>

削除対象の社外連絡先識別番号

Responses

Response samples

default

Content type

application/json

{"error": {"status": "INVALID_ARGUMENT",
"message": "string",
"details": [{"field": "string",
"code": "string",
"description": "string"
}
]
}
}

社外電話帳フォルダ

PA PEOPLE の社外電話帳のフォルダです。

社外電話帳フォルダ一覧取得

社外電話帳（共有/個人）のフォルダの情報を一覧で取得できます。
並びは、電話帳タイプ（共有/個人の順）、フォルダ識別番号（昇順）の順です。

Authorizations:

ApiKeyAuth

query Parameters

page	integer <int32> >= 0 Default: 0 取得対象ページの番号
pageSize	integer <int32> [ 1 .. 100 ] Default: 30 1ページあたりの件数
directory	string Enum: "SHARED" "PERSONAL" 取得対象の電話帳タイプ SHARED: 共有電話帳 PERSONAL: 個人電話帳
folderName	string 取得対象のフォルダ名（部分一致）
editingPrivileges	boolean Default: false 取得対象を編集権限のある電話帳フォルダのみに限定

Responses

Response samples

200
default

Content type

application/json

{"hasMore": true,
"items": [{"folderId": {"directory": "SHARED",
"folderNum": 0
},
"folderName": "string"
}
]
}

共有電話帳フォルダ一覧取得

共有電話帳フォルダの情報を一覧で取得できます。
並びは、フォルダ名（昇順）、作成日（昇順）の順です。

Authorizations:

ApiKeyAuth

query Parameters

page	integer <int32> >= 0 Default: 0 取得対象ページの番号
pageSize	integer <int32> [ 1 .. 100 ] Default: 30 1ページあたりの件数
folderName	string 取得対象のフォルダ名（部分一致）
editingPrivileges	boolean Default: false 取得対象を編集権限のある共有電話帳フォルダのみに限定

Responses

Response samples

200
default

Content type

application/json

{"hasMore": true,
"items": [{"folderNum": 0,
"folderName": "string",
"description": "string",
"tenantPublic": true
}
]
}

共有電話帳フォルダ作成

共有電話帳フォルダを作成できます。
※ ご利用には共有電話帳管理権限が必要です。

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

folderName required	string <= 50 characters ^(?!(\s\|　)*$).+ フォルダ名
description	string <= 50 characters 説明
tenantPublic	boolean Default: false 全社公開

Responses

Request samples

Payload

Content type

application/json

{"folderName": "string",
"description": "string",
"tenantPublic": false
}

Response samples

201
default

Content type

application/json

{"folderNum": 0,
"folderName": "string",
"description": "string",
"tenantPublic": true
}

共有電話帳フォルダ編集

共有電話帳フォルダの情報を編集できます。指定した項目のみ変更が反映されます。
※ ご利用には共有電話帳管理権限が必要です。
※ 編集権限をお持ちのフォルダのみ編集できます。

Authorizations:

ApiKeyAuth

path Parameters

folderNum

required

integer <int64>

編集対象のフォルダ識別番号

Request Body schema: application/json
required

folderName	string <= 50 characters ^(?!(\s\|　)*$).+ フォルダ名
description	string <= 50 characters 説明
tenantPublic	boolean 全社公開

Responses

Request samples

Payload

Content type

application/json

{"folderName": "string",
"description": "string",
"tenantPublic": true
}

Response samples

200
default

Content type

application/json

{"folderNum": 0,
"folderName": "string",
"description": "string",
"tenantPublic": true
}

フォルダの部署権限取得

共有電話帳フォルダの閲覧・編集権限を持つ部署を一覧で取得できます。
※ ご利用には共有電話帳管理権限が必要です。
※ 編集権限をお持ちのフォルダのみ取得できます。
※ 「全社公開」の閲覧権限は取得対象外です。

Authorizations:

ApiKeyAuth

path Parameters

folderNum

required

integer <int64>

取得対象のフォルダ識別番号

query Parameters

page	integer <int32> >= 0 Default: 0 取得対象ページの番号
pageSize	integer <int32> [ 1 .. 1000 ] Default: 30 1ページあたりの件数
divisionIds	Array of integers <int64> <= 50 items [ items <int64 > ] 取得対象の部署識別番号
editable	boolean 取得対象となる部署の編集権限 true: 権限あり false: 権限なし

Responses

Response samples

200
default

Content type

application/json

{"hasMore": true,
"items": [{"divisionId": 0,
"divisionCode": "string",
"divisionName": "string",
"viewable": true,
"editable": true
}
]
}

フォルダの部署権限編集

共有電話帳フォルダの部署ごとの閲覧・編集権限を編集できます。
※ ご利用には共有電話帳管理権限が必要です。
※ 編集権限をお持ちのフォルダのみ編集できます。

Authorizations:

ApiKeyAuth

path Parameters

folderNum

required

integer <int64>

編集対象のフォルダ識別番号

Request Body schema: application/json
required

mode required	string Enum: "SET" "UPSERT" 編集モード SET: divisions の内容で置き換え UPSERT: divisions の内容で、既存の部署は更新、まだ権限のない部署は追加
required	Array of objects <= 50 items フォルダの部署権限情報

Responses

Request samples

Payload

Content type

application/json

{"mode": "SET",
"divisions": [{"divisionId": 0,
"viewable": true,
"editable": true
}
]
}

Response samples

default

Content type

application/json

{"error": {"status": "INVALID_ARGUMENT",
"message": "string",
"details": [{"field": "string",
"code": "string",
"description": "string"
}
]
}
}

フォルダのユーザ権限取得

共有電話帳フォルダの閲覧・編集権限を持つユーザを一覧で取得できます。
※ ご利用には共有電話帳管理権限が必要です。
※ 編集権限をお持ちのフォルダのみ取得できます。
※ 「全社公開」の閲覧権限は取得対象外です。

Authorizations:

ApiKeyAuth

path Parameters

folderNum

required

integer <int64>

取得対象のフォルダ識別番号

query Parameters

page	integer <int32> >= 0 Default: 0 取得対象ページの番号
pageSize	integer <int32> [ 1 .. 1000 ] Default: 30 1ページあたりの件数
userIds	Array of integers <int64> <= 50 items [ items <int64 > ] 取得対象のユーザ識別番号
editable	boolean 取得対象となるユーザの編集権限 true: 権限あり false: 権限なし

Responses

Response samples

200
default

Content type

application/json

{"hasMore": true,
"items": [{"userId": 0,
"loginId": "string",
"fullname": "string",
"viewable": true,
"editable": true
}
]
}

フォルダのユーザ権限編集

共有電話帳フォルダのユーザごとの閲覧・編集権限を編集できます。
※ ご利用には共有電話帳管理権限が必要です。
※ 編集権限をお持ちのフォルダのみ編集できます。

Authorizations:

ApiKeyAuth

path Parameters

folderNum

required

integer <int64>

編集対象のフォルダ識別番号

Request Body schema: application/json
required

mode required	string Enum: "SET" "UPSERT" 編集モード SET: users の内容で置き換え UPSERT: users の内容で、既存のユーザは更新、まだ権限のないユーザは追加
required	Array of objects <= 50 items フォルダのユーザ権限情報

Responses

Request samples

Payload

Content type

application/json

{"mode": "SET",
"users": [{"userId": 0,
"viewable": true,
"editable": true
}
]
}

Response samples

default

Content type

application/json

{"error": {"status": "INVALID_ARGUMENT",
"message": "string",
"details": [{"field": "string",
"code": "string",
"description": "string"
}
]
}
}

個人電話帳フォルダ一覧取得

個人電話帳フォルダの情報を一覧で取得できます。
並びは、ソートスコア（降順）、フォルダ名（昇順）、作成日（昇順）の順です。

Authorizations:

ApiKeyAuth

query Parameters

page	integer <int32> >= 0 Default: 0 取得対象ページの番号
pageSize	integer <int32> [ 1 .. 100 ] Default: 30 1ページあたりの件数
folderName	string 取得対象のフォルダ名（部分一致）

Responses

Response samples

200
default

Content type

application/json

{"hasMore": true,
"items": [{"folderNum": 0,
"folderName": "string",
"sortScore": 0
}
]
}

個人電話帳フォルダ作成

個人電話帳フォルダを作成できます。

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

folderName required	string <= 50 characters ^(?!(\s\|　)*$).+ フォルダ名
sortScore	integer <int32> [ 0 .. 999999999 ] Default: 0 ソートスコア

Responses

Request samples

Payload

Content type

application/json

{"folderName": "string",
"sortScore": 0
}

Response samples

201
default

Content type

application/json

{"folderNum": 0,
"folderName": "string",
"sortScore": 0
}

個人電話帳フォルダ編集

個人電話帳フォルダの情報を編集できます。指定した項目のみ変更が反映されます。

Authorizations:

ApiKeyAuth

path Parameters

folderNum

required

integer <int64>

編集対象のフォルダ識別番号

Request Body schema: application/json
required

folderName	string <= 50 characters ^(?!(\s\|　)*$).+ フォルダ名
sortScore	integer <int32> [ 0 .. 999999999 ] ソートスコア

Responses

Request samples

Payload

Content type

application/json

{"folderName": "string",
"sortScore": 999999999
}

Response samples

200
default

Content type

application/json

{"folderNum": 0,
"folderName": "string",
"sortScore": 0
}

連絡先

連絡先の特定

発信先・発信元の電話番号から連絡先を特定します。

共用番号に該当する連絡先が存在する場合は、その連絡先を返します。
社内連絡先や社外連絡先（共有/個人）に該当する複数の連絡先が存在する場合は、登録日時がもっとも新しい連絡先を返します。
特定できるのは、社内連絡先は権限範囲の連絡先（ユーザ）、社外連絡先（共有/個人）は閲覧権限があるフォルダ内の連絡先です。

Authorizations:

ApiKeyAuth

query Parameters

phoneNums

required

Array of strings <= 5 items [[0-9*#,;+-]+]

特定対象の電話番号

Responses

Response samples

200
default

Content type

application/json

{"items": [{"phoneNum": "string",
"displayName": "string",
"companyName": "string",
"divisionNames": ["string"
],
"phoneNumContactType": "SHARED_NUMBER",
"userId": 0,
"contactId": 0
}
]
}

履歴

PA PEOPLE の発信・着信の履歴です。

着信履歴一覧取得

自分の着信履歴を一覧で取得できます。

Authorizations:

ApiKeyAuth

query Parameters

page	integer <int32> >= 0 Default: 0 取得対象ページの番号
pageSize	integer <int32> [ 1 .. 20 ] Default: 20 1ページあたりの件数
orderDirection	string Default: "asc" Enum: "asc" "desc" 着信日時でのソートの並び順 asc: 昇順 desc: 降順
answered	boolean 通話/不在 true: 通話 false: 不在

Responses

Response samples

200
default

Content type

application/json

{"hasMore": true,
"items": [{"incomingCallHistoryId": 0,
"fromNum": "string",
"fromNumContact": {"displayName": "string",
"companyName": "string",
"divisionNames": ["string"
],
"phoneNumContactType": "SHARED_NUMBER",
"userId": 0,
"contactId": 0
},
"answered": true,
"duration": 0,
"voicemail": {"urlBrowser": "string",
"urlIos": "string",
"urlAndroid": "string"
},
"note": "string",
"calledAt": "2019-08-24T14:15:22+09:00"
}
]
}

着信履歴追加

発信元電話番号を自分の着信履歴に追加できます。

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

fromNum	string <= 50 characters [0-9*#,;+-]+ 発信元電話番号 ※ 非通知着信の場合は指定不要
answered required	boolean 通話/不在 true: 通話 false: 不在
duration	integer <int32> >= 0 通話時間（秒） ※ answered が true の場合は必須 ※ answered が false の場合は指定不要
calledAt required	string <date-time> 着信日時 ※ YYYY-MM-DDThh:mm:ssTZD 形式
	object 留守番電話
note	string <= 50 characters メモ

Responses

Request samples

Payload

Content type

application/json

{"fromNum": "string",
"answered": true,
"duration": 0,
"calledAt": "2019-08-24T14:15:22+09:00",
"voicemail": {"urlBrowser": "string",
"urlIos": "string",
"urlAndroid": "string"
},
"note": "string"
}

Response samples

201
default

Content type

application/json

{"incomingCallHistoryId": 0,
"fromNum": "string",
"fromNumContact": {"displayName": "string",
"companyName": "string",
"divisionNames": ["string"
],
"phoneNumContactType": "SHARED_NUMBER",
"userId": 0,
"contactId": 0
},
"answered": true,
"duration": 0,
"voicemail": {"urlBrowser": "string",
"urlIos": "string",
"urlAndroid": "string"
},
"note": "string",
"calledAt": "2019-08-24T14:15:22+09:00"
}

着信履歴編集

自分の着信履歴を編集できます。指定した項目のみ変更が反映されます。

Authorizations:

ApiKeyAuth

path Parameters

incomingCallHistoryId

required

integer <int64>

着信履歴識別番号

Request Body schema: application/json
required

fromNum	string <= 50 characters [0-9#,;+-] 発信元電話番号 ※ 非通知着信の場合は空文字
answered	boolean 通話/不在 true: 通話 false: 不在
duration	integer <int32> >= 0 通話時間（秒） ※ answered が true の場合は必須 ※ answered が false の場合は指定不要
calledAt	string <date-time> 着信日時 ※ YYYY-MM-DDThh:mm:ssTZD 形式
	object 留守番電話
note	string <= 50 characters メモ

Responses

Request samples

Payload

Content type

application/json

{"fromNum": "string",
"answered": true,
"duration": 0,
"calledAt": "2019-08-24T14:15:22+09:00",
"voicemail": {"urlBrowser": "string",
"urlIos": "string",
"urlAndroid": "string"
},
"note": "string"
}

Response samples

200
default

Content type

application/json

{"incomingCallHistoryId": 0,
"fromNum": "string",
"fromNumContact": {"displayName": "string",
"companyName": "string",
"divisionNames": ["string"
],
"phoneNumContactType": "SHARED_NUMBER",
"userId": 0,
"contactId": 0
},
"answered": true,
"duration": 0,
"voicemail": {"urlBrowser": "string",
"urlIos": "string",
"urlAndroid": "string"
},
"note": "string",
"calledAt": "2019-08-24T14:15:22+09:00"
}

発信履歴一覧取得

自分の発信履歴を一覧で取得できます。

Authorizations:

ApiKeyAuth

query Parameters

page	integer <int32> >= 0 Default: 0 取得対象ページの番号
pageSize	integer <int32> [ 1 .. 20 ] Default: 20 1ページあたりの件数
orderDirection	string Default: "asc" Enum: "asc" "desc" 発信日時でのソートの並び順 asc: 昇順 desc: 降順
answered	boolean 通話/不在 true: 通話 false: 不在

Responses

Response samples

200
default

Content type

application/json

{"hasMore": true,
"items": [{"outgoingCallHistoryId": 0,
"toNum": "string",
"toNumContact": {"displayName": "string",
"companyName": "string",
"divisionNames": ["string"
],
"phoneNumContactType": "SHARED_NUMBER",
"userId": 0,
"contactId": 0
},
"answered": true,
"duration": 0,
"note": "string",
"callingAt": "2019-08-24T14:15:22+09:00"
}
]
}

発信履歴追加

発信先電話番号を自分の発信履歴に追加できます。

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

toNum required	string <= 50 characters [0-9*#,;+-]+ 発信先電話番号
answered required	boolean 通話/不在 true: 通話 false: 不在
duration	integer <int32> >= 0 通話時間（秒） ※ answered が true の場合は必須 ※ answered が false の場合は指定不要
callingAt required	string <date-time> 発信日時 ※ YYYY-MM-DDThh:mm:ssTZD 形式
note	string <= 50 characters メモ

Responses

Request samples

Payload

Content type

application/json

{"toNum": "string",
"answered": true,
"duration": 0,
"callingAt": "2019-08-24T14:15:22+09:00",
"note": "string"
}

Response samples

201
default

Content type

application/json

{"outgoingCallHistoryId": 0,
"toNum": "string",
"toNumContact": {"displayName": "string",
"companyName": "string",
"divisionNames": ["string"
],
"phoneNumContactType": "SHARED_NUMBER",
"userId": 0,
"contactId": 0
},
"answered": true,
"duration": 0,
"note": "string",
"callingAt": "2019-08-24T14:15:22+09:00"
}

発信履歴編集

自分の発信履歴を編集できます。指定した項目のみ変更が反映されます。

Authorizations:

ApiKeyAuth

path Parameters

outgoingCallHistoryId

required

integer <int64>

発信履歴識別番号

Request Body schema: application/json
required

toNum	string <= 50 characters [0-9*#,;+-]+ 発信先電話番号
answered	boolean 通話/不在 true: 通話 false: 不在
duration	integer <int32> >= 0 通話時間（秒） ※ answered が true の場合は必須 ※ answered が false の場合は指定不要
callingAt	string <date-time> 発信日時 ※ YYYY-MM-DDThh:mm:ssTZD 形式
note	string <= 50 characters メモ

Responses

Request samples

Payload

Content type

application/json

{"toNum": "string",
"answered": true,
"duration": 0,
"callingAt": "2019-08-24T14:15:22+09:00",
"note": "string"
}

Response samples

200
default

Content type

application/json

{"outgoingCallHistoryId": 0,
"toNum": "string",
"toNumContact": {"displayName": "string",
"companyName": "string",
"divisionNames": ["string"
],
"phoneNumContactType": "SHARED_NUMBER",
"userId": 0,
"contactId": 0
},
"answered": true,
"duration": 0,
"note": "string",
"callingAt": "2019-08-24T14:15:22+09:00"
}

権限

権限取得

自身と API キーの権限の情報を取得できます。

Authorizations:

ApiKeyAuth

Responses

Response samples

200
default

Content type

application/json

{"roles": ["ADMIN_COMPANY"
],
"apiKeyScopes": ["User.Write"
],
"businessCardReaderMethod": ["MACHINE"
]
}

位置情報

PHONE APPLI PLACE の位置情報です。

位置情報登録

位置情報タグごとのスポット情報を一括して登録できます。
※ 登録したスポット情報は 10 分後に削除されます。
※ ご利用には PHONE APPLI PLACE 管理権限が必要です。
※ レート制限（リクエスト上限）：テナントごと 5 分間に 1 回（エラーの場合はリクエスト数にカウントされません）

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

required

Array of objects [ 1 .. 10000 ] items

位置情報タグごとのスポット情報

Responses

Request samples

Payload

Content type

application/json

{"locations": [{"bleId": "string",
"spotId": "string"
}
]
}

Response samples

202
default

Content type

application/json

{"locationsCount": 0,
"acceptedCount": 0
}

PHONE APPLI API (1.14)

はじめに

利用規約

API キーの発行方法

制限事項

レート制限

レスポンスヘッダ

利用権限

キーの発行数制限

エラーレスポンス

社内連絡先

ユーザタイプによる制限

社内連絡先一覧取得

Authorizations:

query Parameters

Responses

Response samples

社内連絡先作成

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

社内連絡先取得

Authorizations:

path Parameters

Responses

Response samples

社内連絡先編集

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

社内連絡先削除

Authorizations:

path Parameters

Responses

Response samples

顔写真取得

Authorizations:

path Parameters

query Parameters

Responses

Response samples

顔写真更新

Authorizations:

path Parameters

Request Body schema: image/jpegimage/pngimage/gifimage/jpegrequired

Responses

Response samples

顔写真削除

Authorizations:

path Parameters

Responses

Response samples

プロフィール

プロフィール取得

Authorizations:

path Parameters

Responses

Response samples

プロフィール編集

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

行き先

行き先一括編集

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

部署

部署一覧取得

Authorizations:

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema:
image/jpeg
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema:
image/jpeg
required