社外連絡先一覧を取得する
このピースでできることPHONE APPLI PEOPLE の接続方法ステップ 1：API キーを取得するステップ 2：workrun に接続を追加するピースの設定項目1. ページ番号（任意）2. 1 ページあたりの取得件数（任意）3. 並び替え項目（任意）4. 並び順（任意）5. 更新日時（から）（任意）6. 更新日時（まで）（任意）7. 電話帳タイプ（任意）8. フォルダ識別番号（任意）9. 名刺依頼状態（任意）10. 名刺依頼種別（任意）11. 名刺依頼結果（任意）12. 名寄せ後のみ取得（任意）13. 取得対象項目（任意）14. フリーワード検索を使う（任意）15. 検索条件（任意）
このピースでできること
- PHONE APPLI PEOPLE の社外連絡先の一覧を取得します。
- 更新日時・氏名・会社名・電話番号・メールアドレスなど多様な条件で絞り込みができます。
- フリーワード検索や名寄せ済み連絡先のみの取得にも対応しています。
PHONE APPLI PEOPLE の接続方法
workrun と PHONE APPLI PEOPLE を接続するには、PHONE APPLI PEOPLE の API キー が必要です。
ステップ 1：API キーを取得する
- PHONE APPLI PEOPLE の PC ブラウザ版にログインする。
- 画面右上のユーザー名 →「ユーザー情報」を開く。
- 「APIキー」タブを開き、「APIキーを発行」をクリックする。
- 必要なスコープを選択する。
- （「社外連絡先一覧を取得する」アクション・「社外連絡先が登録された時」トリガーで必要）
- 「カスタムAPI呼び出し」アクションで他リソースを操作する場合は、対応するスコープも追加してください。
- 発行された API キーをコピーする。
ステップ 2：workrun に接続を追加する
- workrun で PHONE APPLI PEOPLE のアクションをフローに追加します。
- 「接続を選択」の横にある 「＋ 新しい接続」 をクリックします。
- 「API Key」 フィールドに、ステップ 1 でコピーした API キーを貼り付けます。
- 「保存」 をクリックして接続を完了します。
ピースの設定項目
1. ページ番号（任意）
- 取得したいページの番号を入力します。0 が最初のページです。最大 19 まで指定できます。未入力の場合は 0（最初のページ）が取得されます。
2. 1 ページあたりの取得件数（任意）
- 1 回のリクエストで取得する件数を入力します。最大 300 まで指定できます。未入力の場合は 30 件取得します。
3. 並び替え項目（任意）
- 取得結果の並び替え基準を選択します。「更新日時順」または「氏名カナ順」から選べます。
4. 並び順（任意）
- 「昇順」または「降順」を選択します。
5. 更新日時（から）（任意）
- 絞り込む開始日時を入力します。この日時以降に更新された連絡先を取得します。
6. 更新日時（まで）（任意）
- 絞り込む終了日時を入力します。「更新日時（から）」より前の日時を指定すると結果は空になります。
7. 電話帳タイプ（任意）
- 「共有電話帳」または「個人電話帳」を選択します。フォルダで絞り込む場合は先に選択してください。
8. フォルダ識別番号（任意）
- 特定のフォルダで絞り込む場合に選択します。最大 10 件まで選択できます。「電話帳タイプ」を先に選択すると一覧が表示されます。すべてのフォルダを対象にする場合は空白のままにしてください。
9. 名刺依頼状態（任意）
- 「依頼可能」または「依頼中」で絞り込みます。
10. 名刺依頼種別（任意）
- 「なし」「OCR 名刺登録」「名刺オペレータ入力」で絞り込みます。
11. 名刺依頼結果（任意）
- 「成功」または「失敗」で絞り込みます。
12. 名寄せ後のみ取得（任意）
- チェックすると名寄せ済みの連絡先のみを取得します。「登録者ユーザー識別番号」と同時には指定できません。
13. 取得対象項目（任意）
- 取得したいフィールドを選択します。指定しない場合は API 既定の項目が返ります。氏名・会社名・電話番号など 34 項目から選択できます。
14. フリーワード検索を使う（任意）
- チェックするとフリーワードで AND 検索ができます。チェックすると氏名・会社名など他の絞り込み条件と排他になります。
15. 検索条件（任意）
- 「フリーワード検索を使う」がオフの場合: 会社名・部署名・氏名・電話番号・メールアドレスなどのフィールドで絞り込めます。
- 「フリーワード検索を使う」がオンの場合: フリーワードを複数入力して AND 検索できます（最大 10 件）。