Dulliau Anfon

Mae API Legalesign yn darparu sawl ffordd o anfon dogfennau i'w llofnodi. Mae pob dull yn addas ar gyfer achos defnydd gwahanol. Mae'r holl ddulliau yn anffurfiol — maent yn dychwelyd ID yn syth ac yn prosesu'r ddogfen yn y cefndir.

Cymhariaeth Gyflym

Dull	Achos Defnyddio	Dogfennau	Galwadau API
send	Anfon un ddogfen i un neu fwy o dderbynwyr	1	1
sendBatch	Anfon nifer o ddogfennau gwahanol fel grŵp	Nifer	3+ (creu → ychwanegu dogfennau → dechrau)
sendBulk	Anfon yr un templed i lawer o dderbynwyr gwahanol	Nifer	3+ (dechrau → rhestr aros dogfennau → anfon)
createTask	Rhedeg tasgau anffurfiol fel adroddiadau	N/A	1

send — Dogfen Sengl

Y dull symlaf ac amlaf. Mae un alwad API yn anfon un ddogfen i un neu fwy o dderbynwyr.

mutation {
  send(input: {
    groupId: "Z3JwMTIzNDU2"
    templateId: "dHBsMTIzNDU2"
    title: "Employment Contract"
    recipients: [
      { firstName: "Jane", lastName: "Smith", email: "jane@example.com", role: "Signer" }
    ]
  })
}

Pryd i'w ddefnyddio: Y rhan fwyaf o integreiddiadau. Anfon contract, NDA, neu unrhyw ddogfen sengl. Os oes angen i chi anfon dogfennau un ar y tro o'ch cais, dyma'r ddewis iawn.

Yn dychwelyd: ID tasg. Holwch gyda'r ymholiad task a monitro task.report.status nes iddo gyrraedd COMPLETED neu FAILED.

Gweler: cyfeiriad send · DocumentSendSettingsInput

sendBatch — Nifer o Ddogfennau fel Grŵp

Yn anfon nifer o ddogfennau gwahanol sydd yn gysylltiedig yn rhesymegol (e.e. pecyn cyflogaeth gyda contract, NDA, a chydnabod llawlyfr). Mae'r dogfennau wedi'u grwpio i mewn i Batch a gellir eu hanfon mewn trefn benodol.

Mae'r llif gwaith yn gofyn am dri cham:

# Step 1: Create the batch
mutation { sendBatch(input: { groupId: "Z3JwMTIzNDU2", batchName: "New Hire Pack" }) }
# Returns: batchId

# Step 2: Add documents to the batch (repeat for each document)
mutation { sendBatchDocument(input: {
  batchId: "<batchId>",
  sendOrder: 1,
  document: {
    groupId: "Z3JwMTIzNDU2"
    templateId: "dHBsMTIzNDU2"
    title: "Employment Contract"
    recipients: [{ firstName: "Jane", lastName: "Smith", email: "jane@example.com", role: "Signer" }]
  }
}) }

# Step 3: Start the batch
mutation { startBatch(input: { batchId: "<batchId>", groupId: "Z3JwMTIzNDU2" }) }

Pryd i'w ddefnyddio: Anfon nifer o ddogfennau cysylltiedig i'r un person neu grŵp o bobl. Mae'r faner enforceOrder yn rheoli a ddylid llofnodi dogfennau yn y drefn drefnus ai peidio.

Gweler: sendBatch · sendBatchDocument · startBatch · Math o [Batch](/graphql/reference/types/batch)

sendBulk — Yr Un Templed i Lawer o Dderbynwyr

Yn anfon yr un templed i lawer o dderbynwyr gwahanol ar yr un pryd. Defnyddiol ar gyfer postiadau màs fel adnewyddu polisïau blynyddol neu gydnabyddiaethau cydymffurfio.

Y llif gwaith:

# Step 1: Create the bulk task
mutation { startBulk(input: { groupId: "Z3JwMTIzNDU2", name: "Annual Policy Renewal" }) }
# Returns: bulkId

# Step 2: Queue documents (repeat for each recipient)
mutation { addBulkDocument(input: {
  bulkId: "<bulkId>",
  document: {
    groupId: "Z3JwMTIzNDU2"
    templateId: "dHBsMTIzNDU2"
    title: "Policy Renewal - John Doe"
    recipients: [{ firstName: "John", lastName: "Doe", email: "john@example.com", role: "Signer" }]
  }
}) }

# Step 3: Send all queued documents
mutation { sendBulk(input: { groupId: "Z3JwMTIzNDU2", bulkId: "<bulkId>", name: "Annual Policy Renewal" }) }

Pryd i'w ddefnyddio: Anfon yr un ddogfen i gannoedd neu filoedd o bobl wahanol. Mwy effeithlon na galw send mewn cylch oherwydd bod y llwyfan yn prosesu'r rhestr aros ar y cyd.

Gweler: startBulk · addBulkDocument · sendBulk

createTask — Tasgau Anffurfiol

Nid dull anfon, ond perthnasol. Mae createTask yn sbarduno gweithrediadau anffurfiol fel creu adroddiadau. Mae'r system tasg yr un fath â'r un sy'n pweru send — maent ill dau'n dychwelyd ID tasg y gallwch ei holi.

mutation {
  createTask(input: {
    groupId: "Z3JwMTIzNDU2"
    title: "Audit Report"
    status: DRAFT
  }) {
    id
    status
  }
}

Gweler: createTask · TaskStatus

Dewis y Dull Cywir

Need to send one document?
  → use send

Need to send multiple different documents as a package?
  → use sendBatch

Need to send the same template to many people?
  → use sendBulk

Just need one or two documents sent from your app?
  → use send (even if you call it multiple times)

Dim ond send y mae'r rhan fwyaf o integreiddiadau ei angen. Defnyddiwch sendBatch a sendBulk pan fo gennych llif gwaith penodol sy'n gofyn grwpio neu anfon màs.

Dewisiadau Hysbysu

Mae'r ddau sendBatch a sendBulk yn derbyn baneri hysbysu sy'n rheoli ymddygiad e-bost:

Faner	Disgrifiad
enforceOrder	Rhaid llofnodi dogfennau yn y sendOrder penodedig
notifySender	Anfon e-bost at y sawl sy'n anfon pan fydd pob dogfen wedi'i llofnodi
notifySenderAttach	Ychwanegu'r PDF wedi'i lofnodi at hysbysiad y sawl sy'n anfon
notifyParticipants	Anfon e-bost at y cyfranogwyr pan fydd y ddogfen wedi'i chwblhau
notifyParticipantsAttach	Ychwanegu'r PDF wedi'i lofnodi at hysbysiadau cyfranogwyr

Mae'r newidyn send yn etifeddu'r gosodiadau hyn o ffurfweddiad Experience y grŵp.